com.ibm.websphere.objectgrid
Enum OutputFormat

java.lang.Object
  java.lang.Enum<OutputFormat>
      com.ibm.websphere.objectgrid.OutputFormat

All Implemented Interfaces:

Serializable, Comparable<OutputFormat>

public enum OutputFormat
extends Enum<OutputFormat>

Identifies the data output format from data access APIs and plug-ins.

Since:

8.6

Enum Constant Summary

NATIVE
NATIVE output format refers to deserialized native Java objects.

RAW
RAW output format refers to SerializedEntry object.

UNDEFINED
UNDEFINED output format should only be used by PluginOutputFormat annotation.

Method Summary

static OutputFormat	valueOf(String name) Returns the enum constant of this type with the specified name.
static OutputFormat[]	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

NATIVE

public static final OutputFormat NATIVE

NATIVE output format refers to deserialized native Java objects. This is the default output format for maps that do not have data serializer associated, and maps that copy modes other than CopyMode.COPY_TO_BYTES_RAW is used.

When using a custom DataSerializer plug-in, the native format is the object that is returned via the DataSerializer.inflateDataObject(DataObjectContext, XsDataInputStream) method.

RAW

public static final OutputFormat RAW

RAW output format refers to SerializedEntry object. It is applicable to maps that are configured with CopyMode.COPY_TO_BYTES or CopyMode.COPY_TO_BYTES_RAW. This is the default output format that have data serializer associated, and maps that are configured to use CopyMode.COPY_TO_BYTES_RAW.

UNDEFINED

public static final OutputFormat UNDEFINED

UNDEFINED output format should only be used by PluginOutputFormat annotation. If it is used, the plug-in will receive cache data in the form specified by the configuration.

Method Detail

values

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

Returns:

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

valueOf

public static OutputFormat valueOf(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:

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

NullPointerException - if the argument is null