org.eclipse.persistence.nosql.annotations

Enum DataFormatType

java.lang.Object

java.lang.Enum<DataFormatType>

org.eclipse.persistence.nosql.annotations.DataFormatType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<DataFormatType>

public enum DataFormatType
extends java.lang.Enum<DataFormatType>

Used to configure the data format type for an EIS descriptor.

See Also:

NoSql, EISDescriptor.setDataFormat(String)

Author:

James Sutherland

Since:

EclipseLink 2.4

Enum Constant Summary

Enum Constants

Enum Constant and Description
INDEXED JCA IndexedRecords are used, objects data is decomposed into an array of field values.
MAPPED JCA MappedRecords are used, objects data is decomposed into a Map of key/value pairs.
XML XML data is used.

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

XML

public static final DataFormatType XML

XML data is used. Objects are converted to XML. This is the default data format.

INDEXED

public static final DataFormatType INDEXED

JCA IndexedRecords are used, objects data is decomposed into an array of field values.

MAPPED

public static final DataFormatType MAPPED

JCA MappedRecords are used, objects data is decomposed into a Map of key/value pairs.

Method Detail

values

public static DataFormatType[] 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 (DataFormatType c : DataFormatType.values())
    System.out.println(c);

Returns:

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

valueOf

public static DataFormatType 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