Package net.storm.api.plugins.config

Class ConfigSectionDescriptor

java.lang.Object

net.storm.api.plugins.config.ConfigSectionDescriptor

All Implemented Interfaces:

ConfigObject

public class ConfigSectionDescriptor
extends Object
implements ConfigObject

Describes a configuration section defined in a Config interface.

ConfigSectionDescriptor holds the metadata for a section including its key and the ConfigSection annotation. Sections group related configuration items in a collapsible UI element.

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

See Also:

• ConfigSection
• ConfigDescriptor
• ConfigObject

Constructor Summary

Constructors

Constructor	Description
ConfigSectionDescriptor()

Method Summary

Modifier and Type	Method	Description
String	key()	Gets the section 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

ConfigSectionDescriptor

public ConfigSectionDescriptor()

Method Details

key

public String key()

Gets the section key.

Specified by:

key in interface ConfigObject

Returns:

the unique section identifier

name

public String name()

Gets the display name.

Specified by:

name in interface ConfigObject

Returns:

the name from the ConfigSection annotation

position

public int position()

Gets the display position.

Specified by:

position in interface ConfigObject

Returns:

the position from the ConfigSection annotation