Package org.jjazz.phrasetransform.api

Class PhraseTransform.Info

java.lang.Object

org.jjazz.phrasetransform.api.PhraseTransform.Info

Enclosing interface:

PhraseTransform

public static class PhraseTransform.Info
extends Object

Descriptive info of a PhraseTransform.

Constructor Summary

Constructors

Constructor	Description
Info(String id, String name, String description, PhraseTransformCategory category, Icon icon)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
PhraseTransformCategory	getCategory()	The category of this transform.
String	getDescription()	Describes what this transform does.
Icon	getIcon()	An optional icon representing this transform.
String	getName()	The name of the PhraseTransform.
String	getUniqueId()	A unique id associated to this transform class.
int	hashCode()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Info

public Info(String id,
 String name,
 String description,
 PhraseTransformCategory category,
 Icon icon)

Method Details

getName

public String getName()

The name of the PhraseTransform.

Returns:

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getUniqueId

public String getUniqueId()

A unique id associated to this transform class.

IMPORTANT:
- If Id contains string "hidden", then it is not available to user
- character SAVE_STRING_DELIMITER is forbidden here! (used as a separator in saveAsString()/loadFromString())

Returns:

getCategory

public PhraseTransformCategory getCategory()

The category of this transform.

Used to group PhraseTransforms in the user interface.

Returns:

Can't be null

getDescription

public String getDescription()

Describes what this transform does.

Returns:

Can't be null

getIcon

public Icon getIcon()

An optional icon representing this transform.

Icon size must be ICON_SIZE.

Returns:

Can be null

See Also:

• PhraseTransform.ICON_SIZE