Package net.storm.api.plugins.config

Class ConfigTitleDescriptor

java.lang.Object

net.storm.api.plugins.config.ConfigTitleDescriptor

All Implemented Interfaces:

ConfigObject

public class ConfigTitleDescriptor
extends Object
implements ConfigObject

Describes a configuration title defined in a Config interface.

ConfigTitleDescriptor holds the metadata for a title including its key and the ConfigTitle annotation. Titles provide headings within sections to organize configuration items.

This class implements ConfigObject to participate in the configuration object hierarchy alongside sections and items.

See Also:

• ConfigTitle
• ConfigDescriptor
• ConfigObject

Constructor Summary

Constructors

Constructor	Description
ConfigTitleDescriptor()

Method Summary

Modifier and Type	Method	Description
String	key()	Gets the title key.
String	name()	Gets the display name.
int	position()	Gets the display position.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ConfigTitleDescriptor

public ConfigTitleDescriptor()

Method Details

key

public String key()

Gets the title key.

Specified by:

key in interface ConfigObject

Returns:

the unique title identifier

name

public String name()

Gets the display name.

Specified by:

name in interface ConfigObject

Returns:

the name from the ConfigTitle annotation

position

public int position()

Gets the display position.

Specified by:

position in interface ConfigObject

Returns:

the position from the ConfigTitle annotation