Package org.opentcs.configuration
Annotation Interface ConfigurationEntry
Marks an interface's method that provides a configuration value.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enum
Indicates when changes to the configuration entry's value are applied. -
Required Element Summary
Required ElementsModifier and TypeRequired ElementDescriptionString[]
Returns a list of paragraphs describing what the key/value configures.Returns a description for the data type of this configuration key's values. -
Optional Element Summary
Optional ElementsModifier and TypeOptional ElementDescriptionIndicates when changes to the configuration entry's value are applied.Returns the optional ordering key that this entry belongs to (for grouping/sorting of entries).
-
Element Details
-
type
String typeReturns a description for the data type of this configuration key's values.- Returns:
- A description for the data type of this configuration key's values.
-
description
String[] descriptionReturns a list of paragraphs describing what the key/value configures.- Returns:
- A list of paragraphs describing what the key/value configures.
-
changesApplied
ConfigurationEntry.ChangesApplied changesAppliedIndicates when changes to the configuration entry's value are applied.- Returns:
- A value indicating when changes to the configuration entry's value are applied.
- Default:
UNSPECIFIED
-
orderKey
String orderKeyReturns the optional ordering key that this entry belongs to (for grouping/sorting of entries).- Returns:
- The optional ordering key that this entry belongs to (for grouping/sorting of entries).
- Default:
""
-