org.springframework.geode.pdx

Class PdxInstanceWrapper

java.lang.Object

org.springframework.geode.pdx.PdxInstanceWrapper

All Implemented Interfaces:

java.io.Serializable, org.apache.geode.internal.Sendable, org.apache.geode.pdx.PdxInstance

public class PdxInstanceWrapper
extends java.lang.Object
implements org.apache.geode.pdx.PdxInstance, org.apache.geode.internal.Sendable

The PdxInstanceWrapper class is an implementation of the PdxInstance interface wrapping an existing PdxInstance object and decorating the functionality.

Since:

1.3.0

See Also:

Function, ObjectMapper, JSONFormatter, PdxInstance, WritablePdxInstance, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	ARRAY_BEGIN
protected static java.lang.String	ARRAY_END
static java.lang.String	AT_IDENTIFIER_FIELD_NAME
static java.lang.String	AT_TYPE_FIELD_NAME
static java.lang.String	CLASS_NAME_PROPERTY
protected static java.lang.String	COMMA
protected static java.lang.String	COMMA_NEW_LINE
protected static java.lang.String	COMMA_SPACE
protected static java.lang.String	EMPTY_STRING
protected static java.lang.String	FIELD_TYPE_VALUE
static java.lang.String	ID_FIELD_NAME
protected static java.lang.String	INDENT_STRING
protected static java.lang.String	NEW_LINE
protected static java.lang.String	NO_FIELD_NAME
protected static java.lang.String	OBJECT_BEGIN
protected static java.lang.String	OBJECT_END

Constructor Summary

Constructors

Constructor and Description
PdxInstanceWrapper(org.apache.geode.pdx.PdxInstance pdxInstance) Constructs a new instance of PdxInstanceWrapper initialized with the given, required PdxInstance object used to back this wrapper.

Method Summary

Modifier and Type	Method and Description
org.apache.geode.pdx.WritablePdxInstance	createWriter()
static java.lang.Object	from(java.lang.Object target) Smart, null-safe factory method used to evaluate the given Object and wrap the Object in a new instance of PdxInstanceWrapper if the Object is an instance of PdxInstance or return the given Object as is.
static PdxInstanceWrapper	from(org.apache.geode.pdx.PdxInstance pdxInstance) Factory method used to construct a new instance of PdxInstanceWrapper initialized with the given, required PdxInstance used to back the wrapper.
protected java.lang.Object	getAtIdentifier() Searches for a PDX field declared by the @identifier metadata field on this PdxInstance and returns the value of this field as the identifier for, or identity of, this PdxInstance.
java.lang.String	getClassName()
org.apache.geode.pdx.PdxInstance	getDelegate() Returns a reference to the configured, underlying PdxInstance backing this wrapper.
java.lang.Object	getField(java.lang.String fieldName)
java.util.List<java.lang.String>	getFieldNames()
protected java.lang.Object	getId() Searches for a PDX field name called id on this PdxInstance and returns its value as the identifier for, or identity of, this PdxInstance.
java.lang.Object	getIdentifier() Determines the identifier for, or identity of, this PdxInstance.
java.lang.Object	getObject() Materializes an Object from the PDX bytes described by this PdxInstance.
protected java.util.Optional<com.fasterxml.jackson.databind.ObjectMapper>	getObjectMapper() Returns an Optional reference to a configured Jackson ObjectMapper used to deserialize the JSON generated from PDX back into an Object.
boolean	hasField(java.lang.String fieldName)
boolean	isDeserializable()
boolean	isEnum()
boolean	isIdentityField(java.lang.String fieldName)
void	sendTo(java.io.DataOutput out)
java.lang.String	toString() Returns a String representation of this PdxInstance.
static org.apache.geode.pdx.PdxInstance	unwrap(org.apache.geode.pdx.PdxInstance pdxInstance) Null-safe factory method used to unwrap the given PdxInstance.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.geode.pdx.PdxInstance

equals, hashCode

Field Detail

AT_IDENTIFIER_FIELD_NAME

public static final java.lang.String AT_IDENTIFIER_FIELD_NAME

See Also:

Constant Field Values

AT_TYPE_FIELD_NAME

public static final java.lang.String AT_TYPE_FIELD_NAME

See Also:

Constant Field Values

CLASS_NAME_PROPERTY

public static final java.lang.String CLASS_NAME_PROPERTY

See Also:

Constant Field Values

ID_FIELD_NAME

public static final java.lang.String ID_FIELD_NAME

See Also:

Constant Field Values

NO_FIELD_NAME

protected static final java.lang.String NO_FIELD_NAME

See Also:

Constant Field Values

ARRAY_BEGIN

protected static final java.lang.String ARRAY_BEGIN

See Also:

Constant Field Values

ARRAY_END

protected static final java.lang.String ARRAY_END

See Also:

Constant Field Values

COMMA

protected static final java.lang.String COMMA

See Also:

Constant Field Values

EMPTY_STRING

protected static final java.lang.String EMPTY_STRING

See Also:

Constant Field Values

FIELD_TYPE_VALUE

protected static final java.lang.String FIELD_TYPE_VALUE

See Also:

Constant Field Values

INDENT_STRING

protected static final java.lang.String INDENT_STRING

See Also:

Constant Field Values

NEW_LINE

protected static final java.lang.String NEW_LINE

See Also:

Constant Field Values

COMMA_NEW_LINE

protected static final java.lang.String COMMA_NEW_LINE

See Also:

Constant Field Values

COMMA_SPACE

protected static final java.lang.String COMMA_SPACE

See Also:

Constant Field Values

OBJECT_BEGIN

protected static final java.lang.String OBJECT_BEGIN

See Also:

Constant Field Values

OBJECT_END

protected static final java.lang.String OBJECT_END

See Also:

Constant Field Values

Constructor Detail

PdxInstanceWrapper

public PdxInstanceWrapper(org.apache.geode.pdx.PdxInstance pdxInstance)

Constructs a new instance of PdxInstanceWrapper initialized with the given, required PdxInstance object used to back this wrapper.

Parameters:

pdxInstance - PdxInstance object used to back this wrapper; must not be null.

Throws:

java.lang.IllegalArgumentException - if PdxInstance is null.

See Also:

PdxInstance

Method Detail

from

public static java.lang.Object from(java.lang.Object target)

Smart, null-safe factory method used to evaluate the given Object and wrap the Object in a new instance of PdxInstanceWrapper if the Object is an instance of PdxInstance or return the given Object as is.

Parameters:

target - Object to evaluate

Returns:

the Object wrapped in a new instance of PdxInstanceWrapper if Object is an instance of PdxInstance, otherwise returns the given Object.

See Also:

PdxInstance, Object, from(PdxInstance)

from

public static PdxInstanceWrapper from(org.apache.geode.pdx.PdxInstance pdxInstance)

Factory method used to construct a new instance of PdxInstanceWrapper initialized with the given, required PdxInstance used to back the wrapper.

Parameters:

pdxInstance - PdxInstance object used to back this wrapper; must not be null.

Returns:

a new instance of PdxInstanceWrapper initialized with the given PdxInstance.

Throws:

java.lang.IllegalArgumentException - if PdxInstance is null.

See Also:

PdxInstance, PdxInstanceWrapper(PdxInstance)

unwrap

public static org.apache.geode.pdx.PdxInstance unwrap(org.apache.geode.pdx.PdxInstance pdxInstance)

Null-safe factory method used to unwrap the given PdxInstance. If the given PdxInstance is an instance of PdxInstanceWrapper then this factory method will unwrap the PdxInstanceWrapper returning the underlying, delegate PdxInstance. Otherwise, the given PdxInstance is returned.

Parameters:

pdxInstance - PdxInstance to unwrap; may be null.

Returns:

the unwrapped PdxInstance.

See Also:

PdxInstance, getDelegate()

getDelegate

public org.apache.geode.pdx.PdxInstance getDelegate()

Returns a reference to the configured, underlying PdxInstance backing this wrapper.

Returns:

a reference to the configured, underlying PdxInstance backing this wrapper; never null.

See Also:

PdxInstance

getObjectMapper

protected java.util.Optional<com.fasterxml.jackson.databind.ObjectMapper> getObjectMapper()

Returns an Optional reference to a configured Jackson ObjectMapper used to deserialize the JSON generated from PDX back into an Object. This method is meant ot be overridden by subclasses.

Returns:

an Optional ObjectMapper.

See Also:

ObjectMapper, Optional

getClassName

public java.lang.String getClassName()

Specified by:

getClassName in interface org.apache.geode.pdx.PdxInstance

isDeserializable

public boolean isDeserializable()

Specified by:

isDeserializable in interface org.apache.geode.pdx.PdxInstance

isEnum

public boolean isEnum()

Specified by:

isEnum in interface org.apache.geode.pdx.PdxInstance

getField

public java.lang.Object getField(java.lang.String fieldName)

Specified by:

getField in interface org.apache.geode.pdx.PdxInstance

getFieldNames

public java.util.List<java.lang.String> getFieldNames()

Specified by:

getFieldNames in interface org.apache.geode.pdx.PdxInstance

getIdentifier

public java.lang.Object getIdentifier()

Determines the identifier for, or identity of, this PdxInstance.

Returns:

the identifier for this PdxInstance; never null.

Throws:

java.lang.IllegalStateException - if the PdxInstance does not have an id.

See Also:

isIdentityField(String), getField(String), getFieldNames(), getId()

getId

protected java.lang.Object getId()

Searches for a PDX field name called id on this PdxInstance and returns its value as the identifier for, or identity of, this PdxInstance.

Returns:

the value of the id field on this PdxInstance.

Throws:

java.lang.IllegalStateException - if this PdxInstance does not have an id.

See Also:

getAtIdentifier(), getField(String), hasField(String)

getAtIdentifier

protected java.lang.Object getAtIdentifier()

Searches for a PDX field declared by the @identifier metadata field on this PdxInstance and returns the value of this field as the identifier for, or identity of, this PdxInstance.

Returns:

the value of the field declared in the @identifier metadata field on this PdxInstance.

Throws:

java.lang.IllegalStateException - if the PdxInstance does not have an id.

See Also:

PdxInstance

isIdentityField

public boolean isIdentityField(java.lang.String fieldName)

Specified by:

isIdentityField in interface org.apache.geode.pdx.PdxInstance

getObject

public java.lang.Object getObject()

Materializes an Object from the PDX bytes described by this PdxInstance. If these PDX bytes describe an Object parsed from JSON, then the JSON is reconstructed from this PdxInstance and mapped to an instance of the type identified by the @type metadata PDX field using Jackson's ObjectMapper.

Specified by:

getObject in interface org.apache.geode.pdx.PdxInstance

Returns:

an Object constructed from the PDX bytes described by this PdxInstance.

See Also:

ObjectMapper, Object, getObjectMapper()

createWriter

public org.apache.geode.pdx.WritablePdxInstance createWriter()

Specified by:

createWriter in interface org.apache.geode.pdx.PdxInstance

hasField

public boolean hasField(java.lang.String fieldName)

Specified by:

hasField in interface org.apache.geode.pdx.PdxInstance

sendTo

public void sendTo(java.io.DataOutput out)
            throws java.io.IOException

Specified by:

sendTo in interface org.apache.geode.internal.Sendable

Throws:

java.io.IOException

toString

public java.lang.String toString()

Returns a String representation of this PdxInstance.

Specified by:

toString in interface org.apache.geode.pdx.PdxInstance

Overrides:

toString in class java.lang.Object

Returns:

a String representation of this PdxInstance.

See Also:

String