com.adobe.xmp.core.serializer

Enum SerializeOptions.Option

java.lang.Object

java.lang.Enum<SerializeOptions.Option>

com.adobe.xmp.core.serializer.SerializeOptions.Option

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SerializeOptions.Option>

Enclosing class:

SerializeOptions

public static enum SerializeOptions.Option
extends java.lang.Enum<SerializeOptions.Option>

Enum for all serialization options.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CANONICAL_FORMAT Serialize to the canonical form of RDF if set.
ENCODE_UTF16BE Serializes with UTF-16 Big Endian encoding.
ENCODE_UTF16LE Serializes with UTF-16 Little Endian encoding.
EXACT_PACKET_LENGTH If this option is set, the padding parameter is interpreted to be the overall packet length.
INCLUDE_THUMBNAIL_PAD Include a padding allowance for a thumbnail image.
NO_PACKET_WRAPPER Omit the XML packet wrapper.
NO_VERSION_ATTRIBUTE Omits the Toolkit version attribute, not published, only used for Unit tests.
NO_XMPMETA_ELEMENT Omit the <x:xmpmeta>-tag
READONLY_PACKET Mark packet as read-only.
SORT Sort the struct properties, unordered arrays and qualifiers before serializing

Method Summary

Modifier and Type	Method and Description
static SerializeOptions.Option	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static SerializeOptions.Option[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NO_PACKET_WRAPPER

public static final SerializeOptions.Option NO_PACKET_WRAPPER

Omit the XML packet wrapper.

NO_XMPMETA_ELEMENT

public static final SerializeOptions.Option NO_XMPMETA_ELEMENT

Omit the <x:xmpmeta>-tag

NO_VERSION_ATTRIBUTE

public static final SerializeOptions.Option NO_VERSION_ATTRIBUTE

Omits the Toolkit version attribute, not published, only used for Unit tests.

READONLY_PACKET

public static final SerializeOptions.Option READONLY_PACKET

Mark packet as read-only. Default is a writable packet. This option can only be applied if the option NO_PACKET_WRAPPER isn't set.

CANONICAL_FORMAT

public static final SerializeOptions.Option CANONICAL_FORMAT

Serialize to the canonical form of RDF if set. The compact form is the default serialization format (if this option is not set). To serialize to the canonical form, set the flag USE_CANONICAL_FORMAT.

INCLUDE_THUMBNAIL_PAD

public static final SerializeOptions.Option INCLUDE_THUMBNAIL_PAD

Include a padding allowance for a thumbnail image. If no xmp:Thumbnails property is present, the typical space for a JPEG thumbnail is used.

EXACT_PACKET_LENGTH

public static final SerializeOptions.Option EXACT_PACKET_LENGTH

If this option is set, the padding parameter is interpreted to be the overall packet length. The actual amount of padding is computed. An exception is thrown if the packet exceeds this length with no padding.

SORT

public static final SerializeOptions.Option SORT

Sort the struct properties, unordered arrays and qualifiers before serializing

ENCODE_UTF16BE

public static final SerializeOptions.Option ENCODE_UTF16BE

Serializes with UTF-16 Big Endian encoding. UTF-8 is the default

ENCODE_UTF16LE

public static final SerializeOptions.Option ENCODE_UTF16LE

Serializes with UTF-16 Little Endian encoding. UTF-8 is the default

Method Detail

values

public static SerializeOptions.Option[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (SerializeOptions.Option c : SerializeOptions.Option.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static SerializeOptions.Option valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null