Package com.itextpdf.kernel.xmp.options

Class AliasOptions

java.lang.Object
com.itextpdf.kernel.xmp.options.Options
com.itextpdf.kernel.xmp.options.AliasOptions
public final class AliasOptions extends Options
Options for XMPSchemaRegistryImpl#registerAlias.
Since:
20.02.2006

  • Field Details

    • PROP_DIRECT

      public static final int PROP_DIRECT
      This is a direct mapping. The actual data type does not matter.
      See Also:

    • PROP_ARRAY

      public static final int PROP_ARRAY
      The actual is an unordered array, the alias is to the first element of the array.
      See Also:

    • PROP_ARRAY_ORDERED

      public static final int PROP_ARRAY_ORDERED
      The actual is an ordered array, the alias is to the first element of the array.
      See Also:

    • PROP_ARRAY_ALTERNATE

      public static final int PROP_ARRAY_ALTERNATE
      The actual is an alternate array, the alias is to the first element of the array.
      See Also:

    • PROP_ARRAY_ALT_TEXT

      public static final int PROP_ARRAY_ALT_TEXT
      The actual is an alternate text array, the alias is to the 'x-default' element of the array.
      See Also:

  • Constructor Details

    • AliasOptions

      public AliasOptions()
      See Also:

    • AliasOptions

      public AliasOptions (int options) throws XMPException
      Parameters:
      options - the options to init with
      Throws:
      XMPException - If options are not consistant

  • Method Details

    • isSimple

      public boolean isSimple()
      Returns:
      Returns if the alias is of the simple form.

    • isArray

      public boolean isArray()
      Returns:
      Returns the option.

    • setArray

      public AliasOptions setArray (boolean value)
      Parameters:
      value - the value to set
      Returns:
      Returns the instance to call more set-methods.

    • isArrayOrdered

      public boolean isArrayOrdered()
      Returns:
      Returns the option.

    • setArrayOrdered

      public AliasOptions setArrayOrdered (boolean value)
      Parameters:
      value - the value to set
      Returns:
      Returns the instance to call more set-methods.

    • isArrayAlternate

      public boolean isArrayAlternate()
      Returns:
      Returns the option.

    • setArrayAlternate

      public AliasOptions setArrayAlternate (boolean value)
      Parameters:
      value - the value to set
      Returns:
      Returns the instance to call more set-methods.

    • isArrayAltText

      public boolean isArrayAltText()
      Returns:
      Returns the option.

    • setArrayAltText

      public AliasOptions setArrayAltText (boolean value)
      Parameters:
      value - the value to set
      Returns:
      Returns the instance to call more set-methods.

    • toPropertyOptions

      public PropertyOptions toPropertyOptions() throws XMPException
      Returns:
      returns a PropertyOptionss object
      Throws:
      XMPException - If the options are not consistant.

    • defineOptionName

      protected String defineOptionName (int option)
      Description copied from class: Options
      To be implemeted by inheritants.
      Specified by:
      defineOptionName in class Options
      Parameters:
      option - a single, valid option bit.
      Returns:
      Returns a human readable name for an option bit.
      See Also:

    • getValidOptions

      protected int getValidOptions()
      Description copied from class: Options
      To be implemeted by inheritants.
      Specified by:
      getValidOptions in class Options
      Returns:
      Returns a bit mask where all valid option bits are set.
      See Also: