Package org.opentcs.configuration

Annotationsschnittstelle ConfigurationEntry

@Target(METHOD)
@Retention(RUNTIME)
@Documented
public @interface ConfigurationEntry

Marks an interface's method that provides a configuration value.

Verschachtelte Klassen - Übersicht

Verschachtelte Klassen

Modifizierer und Typ	Klasse	Beschreibung
static enum	ConfigurationEntry.ChangesApplied	Indicates when changes to the configuration entry's value are applied.

Erforderliche Elemente - Übersicht

Erforderliche Elemente

Modifizierer und Typ	Erforderliches Element	Beschreibung
String[]	description	Returns a list of paragraphs describing what the key/value configures.
String	type	Returns a description for the data type of this configuration key's values.

Optionale Elemente - Übersicht

Optionale Elemente

Modifizierer und Typ	Optionales Element	Beschreibung
ConfigurationEntry.ChangesApplied	changesApplied	Indicates when changes to the configuration entry's value are applied.
String	orderKey	Returns the optional ordering key that this entry belongs to (for grouping/sorting of entries).

Elementdetails

type

String type

Returns a description for the data type of this configuration key's values.

Gibt zurück:

A description for the data type of this configuration key's values.

description

String[] description

Returns a list of paragraphs describing what the key/value configures.

Gibt zurück:

A list of paragraphs describing what the key/value configures.

changesApplied

ConfigurationEntry.ChangesApplied changesApplied

Indicates when changes to the configuration entry's value are applied.

Gibt zurück:

A value indicating when changes to the configuration entry's value are applied.

Standard:

UNSPECIFIED

orderKey

String orderKey

Returns the optional ordering key that this entry belongs to (for grouping/sorting of entries).

Gibt zurück:

The optional ordering key that this entry belongs to (for grouping/sorting of entries).

Standard:

""