Package org.eclipse.jdt.ui.cleanup

Class CleanUpOptions

  • public class CleanUpOptions
extends CleanUpOptionsCore
    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.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String FALSE
      False value
      static java.lang.String TRUE
      True value

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
        CleanUpOptions()
      Creates a new instance.
      protected CleanUpOptions​(java.util.Map<java.lang.String,​java.lang.String> options)
      Creates a new CleanUpOptions instance with the given options.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.util.Set<java.lang.String> getKeys()
      Returns an unmodifiable set of all known keys.
      java.lang.String getValue​(java.lang.String key)
      Returns the value for the given key.
      boolean isEnabled​(java.lang.String key)
      Tells whether the option with the given key is enabled.
      void setOption​(java.lang.String key, java.lang.String value)
      Sets the option for the given key to the given value.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • CleanUpOptions

        protected CleanUpOptions​(java.util.Map<java.lang.String,​java.lang.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

      • getKeys

        public java.util.Set<java.lang.String> getKeys()
        Description copied from class: CleanUpOptionsCore
        Returns an unmodifiable set of all known keys.
        Overrides:
        getKeys in class CleanUpOptionsCore
        Returns:
        an unmodifiable set of all keys

      • getValue

        public java.lang.String getValue​(java.lang.String key)
        Description copied from class: CleanUpOptionsCore
        Returns the value for the given key.
        Overrides:
        getValue in class CleanUpOptionsCore
        Parameters:
        key - the key of the value
        Returns:
        the value associated with the key

      • isEnabled

        public boolean isEnabled​(java.lang.String key)
        Description copied from class: CleanUpOptionsCore
        Tells whether the option with the given key is enabled.
        Overrides:
        isEnabled in class CleanUpOptionsCore
        Parameters:
        key - the name of the option
        Returns:
        true if enabled, false if not enabled or unknown key
        See Also:
        CleanUpConstants