de.aristaflow.adept2.model.common

Interface ConfigurationDescription

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

ChangeableConfigurationDescription

public interface ConfigurationDescription
extends java.io.Serializable

The configuration description defines the entries of a corresponding configuration, specifies the types and further restrictions for the configuration values as well as a description for the user.

Author:

Ulrich Kreher

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ConfigurationDescription.ConfigurationEntry A configuration entry declares a configuration value and provides additional information for it, that is a name for the entry, a description, the data type and restrictions on the type as well as the usage of the configuration value.

Field Summary

Fields

Modifier and Type	Field and Description
static long	serialVersionUID Generated ID for serialisation.

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,ConfigurationDescription.ConfigurationEntry>	getEntries() Gets a map containing all entries for this configuration description indexed by the name of the entry (ConfigurationDescription.ConfigurationEntry.getName()).
ConfigurationDescription.ConfigurationEntry	getEntry(java.lang.String entryName) Returns the configuration entry with the designated name or null if no entry with that name exists.

Field Detail

serialVersionUID

static final long serialVersionUID

Generated ID for serialisation.

See Also:

Constant Field Values

Method Detail

getEntry

ConfigurationDescription.ConfigurationEntry getEntry(java.lang.String entryName)

Returns the configuration entry with the designated name or null if no entry with that name exists.

Parameters:

entryName - The name of the configuration entry to return.

Returns:

The configuration entry or null if no entry with that name exists.

getEntries

java.util.Map<java.lang.String,ConfigurationDescription.ConfigurationEntry> getEntries()

Gets a map containing all entries for this configuration description indexed by the name of the entry (ConfigurationDescription.ConfigurationEntry.getName()). This name is also the key to retrieve the value from the appropriate Configuration.

Returns:

The entries for this configuration description indexed by their corresponding names.