Package uk.co.caprica.vlcj.factory

Class ModuleDescription

java.lang.Object

uk.co.caprica.vlcj.factory.ModuleDescription

public final class ModuleDescription
extends Object

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

Constructor Summary

Constructors

Constructor	Description
ModuleDescription(String name, String shortName, String longName, String help)	Create a new module description

Method Summary

Modifier and Type	Method	Description
String	help()	Get the module help text.
String	longName()	Get the module long name.
String	name()	Get the module name.
String	shortName()	Get the module short name.
String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ModuleDescription

public ModuleDescription(String name,
                         String shortName,
                         String longName,
                         String help)

Create a new module description

Parameters:

name - name

shortName - short name

longName - long name

help - help text

Method Detail

name

public String name()

Get the module name.

Returns:

name

shortName

public String shortName()

Get the module short name.

Returns:

short name

longName

public String longName()

Get the module long name.

Returns:

long name

help

public String help()

Get the module help text.

Returns:

help text

toString

public String toString()

Overrides:

toString in class Object