Package de.aristaflow.adept2.model.common

Interface ChangeableConfigurationDescription

  • All Superinterfaces:
    ConfigurationDescription, Serializable
    public interface ChangeableConfigurationDescription
extends ConfigurationDescription
    This interface extends the ConfigurationDescription by the means to add or remove configuration entries. Configuration entries are identified by their name, therefore it suffices to remove by name while adding requires complete objects.

    When removing an entry, also adapt the corresponding configuration(s)!

    Author:
    Ulrich Kreher

    • Field Detail

      • serialVersionUID

        static final long serialVersionUID
        Generated ID for serialisation.
        See Also:
        Constant Field Values

    • Method Detail

      • setEntry

        void setEntry​(ConfigurationDescription.ConfigurationEntry entry)
        Adds or updates the designated configuration entry to/of this description. The value may then be set in the corresponding configuration or in a child configuration.
        When changing the type or the restrictions of a configuration entry, the corresponding configuration needs to be checked whether a configuration value is provided. If it is not valid any more, it will have to be removed.

        A configuration entry is identified by its name, therefore if an entry with the designated name already exists, an update will be performed, otherwise a new entry will be created. The name must neither be null nor the empty string.

        Parameters:
        entry - The new or changed configuration entry for this description. Whether it is new or updated depends on the name of the entry. When updating the type or restrictions of the entry, configuration values of the corresponding configurations may be removed. This must not have null or the empty string as name.

      • removeEntry

        void removeEntry​(String name)
        Removes the entry with the designated name from this configuration description.
        Calling this method will have no effects if the entry with the designated name is already inherited.
        Parameters:
        name - The name of the configuration entry to remove from this configuration description. This must neither be null nor the empty string.