Package com.adobe.xmp.options

Class Options

java.lang.Object
com.adobe.xmp.options.Options
Direct Known Subclasses:
AliasOptions, IteratorOptions, ParseOptions, PropertyOptions, SerializeOptions
public abstract class Options extends Object
The base class for a collection of 32 flag bits. Individual flags are defined as enum value bit masks. Inheriting classes add convenience accessor methods.
Since:
24.01.2006

  • Constructor Details

    • Options

      public Options()
      The default constructor.

    • Options

      public Options(int options) throws XMPException
      Constructor with the options bit mask.
      Parameters:
      options - the options bit mask
      Throws:
      XMPException - If the options are not correct

  • Method Details

    • clear

      public void clear()
      Resets the options.

    • isExactly

      public boolean isExactly(int optionBits)
      Parameters:
      optionBits - an option bitmask
      Returns:
      Returns true, if this object is equal to the given options.

    • containsAllOptions

      public boolean containsAllOptions(int optionBits)
      Parameters:
      optionBits - an option bitmask
      Returns:
      Returns true, if this object contains all given options.

    • containsOneOf

      public boolean containsOneOf(int optionBits)
      Parameters:
      optionBits - an option bitmask
      Returns:
      Returns true, if this object contain at least one of the given options.

    • setOption

      public void setOption(int optionBits, boolean value)
      Parameters:
      optionBits - the binary bit or bits that shall be set to the given value
      value - the boolean value to set

    • getOptions

      public int getOptions()
      Is friendly to access it during the tests.
      Returns:
      Returns the options.

    • setOptions

      public void setOptions(int options) throws XMPException
      Parameters:
      options - The options to set.
      Throws:
      XMPException - If the options are not correct

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object
      See Also:

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
      See Also:

    • getOptionsString

      public String getOptionsString()
      Creates a human readable string from the set options. Note: This method is quite expensive and should only be used within tests or as
      Returns:
      Returns a String listing all options that are set to true by their name, like "option1 | option4".

    • toString

      public String toString()
      Overrides:
      toString in class Object
      Returns:
      Returns the options as hex bitmask.