com.ibm.websphere.objectgrid.query
Enum ObjectQuery.ResultType

java.lang.Object
  java.lang.Enum<ObjectQuery.ResultType>
      com.ibm.websphere.objectgrid.query.ObjectQuery.ResultType

All Implemented Interfaces:

Serializable, Comparable<ObjectQuery.ResultType>

Enclosing interface:

ObjectQuery

public static enum ObjectQuery.ResultType
extends Enum<ObjectQuery.ResultType>

The result type indicates when the query engine will return the cached objects results in their native Object form or in the RAW form. The RAW form is only valid when using a DataSerializer, which represents cache object keys and values as SerializedEntry objects. For a query using ObjectMaps that are configured with a KeySerializerPlugin or ValueSerializerPlugin, the ResultType.RAW value indicates that the type of cache objects returned from those maps will be SerializedEntry

The default ResultType is Native.

Attribute objects returned from the query will be in their native Java format.

Since:

WXS 7.1.1

Enum Constant Summary

NATIVE
For the NATIVE ResultType, a query returns the deserialized native Java objects for keys and objects from ObjectMaps configured with a KeySerializerPlugin or ValueSerializerPlugin.

RAW
For the RAW result type, a query using an ObjectMap that is configured with a KeySerializerPlugin or ValueSerializerPlugin, the keys and values objects returned from the query will be SerializedKey or SerializedValue objects respectively.

Method Summary

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

For the NATIVE ResultType, a query returns the deserialized native Java objects for keys and objects from ObjectMaps configured with a KeySerializerPlugin or ValueSerializerPlugin.

RAW

public static final ObjectQuery.ResultType RAW

For the RAW result type, a query using an ObjectMap that is configured with a KeySerializerPlugin or ValueSerializerPlugin, the keys and values objects returned from the query will be SerializedKey or SerializedValue objects respectively.

If required, you can use the SerializedEntry.getObject() method to retrieve (possibly inflating the serialized object) the original key or value object.

Attribute objects returned from the query will be in their native format even if the RAW result type is set.

Method Detail

values

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

Returns:

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

valueOf

public static ObjectQuery.ResultType 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