Class CleanUpOptions


  • public class CleanUpOptions
    extends Object
    Allows to set and retrieve clean up settings for given options keys.
    Since:
    3.5
    Restriction:
    This class is not intended to be subclassed by clients.
    • Constructor Detail

      • CleanUpOptions

        protected CleanUpOptions​(Map<String,​String> options)
        Creates a new CleanUpOptions instance with the given options.
        Parameters:
        options - map that maps clean ups keys (String) to a non-null string value
      • CleanUpOptions

        public CleanUpOptions()
        Creates a new instance.
    • Method Detail

      • isEnabled

        public boolean isEnabled​(String key)
        Tells whether the option with the given key is enabled.
        Parameters:
        key - the name of the option
        Returns:
        true if enabled, false if not enabled or unknown key
        Throws:
        IllegalArgumentException - if the key is null
        See Also:
        CleanUpConstants
      • getValue

        public String getValue​(String key)
        Returns the value for the given key.
        Parameters:
        key - the key of the value
        Returns:
        the value associated with the key
        Throws:
        IllegalArgumentException - if the key is null or unknown
      • setOption

        public void setOption​(String key,
                              String value)
        Sets the option for the given key to the given value.
        Parameters:
        key - the name of the option to set
        value - the value of the option
        Throws:
        IllegalArgumentException - if the key is null
        See Also:
        TRUE, FALSE
      • getKeys

        public Set<String> getKeys()
        Returns an unmodifiable set of all known keys.
        Returns:
        an unmodifiable set of all keys