Package com.digimarc.dms.payload

Enum Class Payload.DataFormatMode

java.lang.Object

java.lang.Enum<Payload.DataFormatMode>

com.digimarc.dms.payload.Payload.DataFormatMode

All Implemented Interfaces:

Serializable, Comparable<Payload.DataFormatMode>, Constable

Enclosing class:

Payload

public static enum Payload.DataFormatMode
extends Enum<Payload.DataFormatMode>

Used with the Payload.getData(DataFormatMode) method for formatting payload data. Compatible is recommended for most applications.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
Compatible	Compatible mode expresses data in the most compatible format.
Native	Native mode expresses the full data from a payload in a format that is native to the symbology.

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

Compatible

public static final Payload.DataFormatMode Compatible

Compatible mode expresses data in the most compatible format. The payload data is formatted, where possible, as traditional barcode types. Compatible mode is best when a developer wants to handle codes in their original format (for example UPC-A, UPC-E).

For digital watermark payloads Compatible mode often returns a more specific representation than Native mode. For example, if a digital watermark contains a product barcode value (UPC or EAN), Compatible mode returns the specific representation for the code (UPC-A for example), while Native mode returns a GTIN-14 value in a GS1 AI string.

Native

public static final Payload.DataFormatMode Native

Native mode expresses the full data from a payload in a format that is native to the symbology. Native mode is best when a developer wants full, detailed data from digital watermark payloads.

For digital watermark payloads, Native mode usually returns data as a Payload.BasicRepresentation.GS1_List. For 1D and 2D barcodes, the data and representation returned in Native mode is the same as in Compatible mode.

Method Details

values

public static Payload.DataFormatMode[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static Payload.DataFormatMode valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null