uk.co.caprica.vlcj.player
Class ModuleDescription

java.lang.Object
  extended by uk.co.caprica.vlcj.player.ModuleDescription

public class ModuleDescription
extends java.lang.Object

Description of a module (e.g. audio/video filter).


Constructor Summary
ModuleDescription(java.lang.String name, java.lang.String shortName, java.lang.String longName, java.lang.String help)
          Create a new module description
 
Method Summary
 java.lang.String help()
          Get the module help text.
 java.lang.String longName()
          Get the module long name.
 java.lang.String name()
          Get the module name.
 java.lang.String shortName()
          Get the module short name.
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ModuleDescription

public ModuleDescription(java.lang.String name,
                         java.lang.String shortName,
                         java.lang.String longName,
                         java.lang.String help)
Create a new module description

Parameters:
name - name
shortName - short name
longName - long name
help - help text
Method Detail

name

public java.lang.String name()
Get the module name.

Returns:
name

shortName

public java.lang.String shortName()
Get the module short name.

Returns:
short name

longName

public java.lang.String longName()
Get the module long name.

Returns:
long name

help

public java.lang.String help()
Get the module help text.

Returns:
help text

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

(C)2010 Caprica Software Limited