com.marklogic.client.extra.gson

Class GSONHandle

java.lang.Object

com.marklogic.client.impl.HandleImplementation<R,W>

com.marklogic.client.io.BaseHandle<java.io.InputStream,java.lang.String>

com.marklogic.client.extra.gson.GSONHandle

All Implemented Interfaces:

ContentDescriptor, AbstractReadHandle, AbstractWriteHandle, BufferableContentHandle<com.google.gson.JsonElement,java.io.InputStream>, BufferableHandle, ContentHandle<com.google.gson.JsonElement>, DocumentMetadataReadHandle, DocumentMetadataWriteHandle, DocumentPatchHandle, JSONReadHandle, JSONWriteHandle, QueryOptionsListReadHandle, QueryOptionsReadHandle, QueryOptionsWriteHandle, ResendableContentHandle<com.google.gson.JsonElement,java.io.InputStream>, RuleListReadHandle, RuleReadHandle, RuleWriteHandle, SearchReadHandle, SPARQLResultsReadHandle, StructureReadHandle, StructureWriteHandle, TriplesReadHandle, TriplesWriteHandle, TuplesReadHandle, ValuesListReadHandle, ValuesReadHandle

public class GSONHandle
extends BaseHandle<java.io.InputStream,java.lang.String>
implements ResendableContentHandle<com.google.gson.JsonElement,java.io.InputStream>, JSONReadHandle, JSONWriteHandle, StructureReadHandle, StructureWriteHandle

A GSONHandle represents JSON content as a GSON JsonElement for reading or writing. You must install the GSON library to use this class.

Field Summary

Fields inherited from interface com.marklogic.client.document.ContentDescriptor

UNKNOWN_LENGTH

Constructor Summary

Constructors

Constructor and Description
GSONHandle() Zero-argument constructor.
GSONHandle(com.google.gson.JsonElement content) Provides a handle on JSON content as a tree.

Method Summary

Modifier and Type	Method and Description
com.google.gson.JsonElement	bytesToContent(byte[] buffer) Converts a byte serialization to the content representation.
byte[]	contentToBytes(com.google.gson.JsonElement content) Converts the content representation to bytes.
void	fromBuffer(byte[] buffer) Sets the content of the handle by copying from a byte array buffer encoded in UTF-8.
com.google.gson.JsonElement	get() Returns the root node of the JSON tree.
java.lang.Class<com.google.gson.JsonElement>	getContentClass() Returns the class of the handled content, which may be a base class of the actual class of a content object.
com.google.gson.JsonParser	getParser() Deprecated. Use static methods like JsonParser.parseString() or JsonParser.parseReader() directly instead
static ContentHandleFactory	newFactory() Creates a factory to create a GSONHandle instance for a JsonElement node.
GSONHandle	newHandle() Constructs a new handle for the same content representation, initializing the new handle with the same format and mime type.
GSONHandle[]	newHandleArray(int length) Constructs an uninitialized array with the specified length with items of the same content representation.
protected java.lang.Class<java.io.InputStream>	receiveAs()
protected void	receiveContent(java.io.InputStream serialization)
protected java.lang.String	sendContent()
void	set(com.google.gson.JsonElement content) Assigns a JSON tree as the content.
void	setFormat(Format format) Restricts the format to JSON.
byte[]	toBuffer() Copies the content of the handle to a byte array buffer encoded in UTF-8.
com.google.gson.JsonElement	toContent(java.io.InputStream serialization) Converts the serialization to the content representation.
java.lang.String	toString() Returns the JSON tree as a string.
GSONHandle	with(com.google.gson.JsonElement content) Assigns a JSON tree as the content and returns the handle.

Methods inherited from class com.marklogic.client.io.BaseHandle

getByteLength, getFormat, getMimetype, getServerTimestamp, setByteLength, setMimetype, setServerTimestamp

Methods inherited from class com.marklogic.client.impl.HandleImplementation

getPointInTimeQueryTimestamp, isResendable, setPointInTimeQueryTimestamp, setResendable, setResponseServerTimestamp

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.marklogic.client.io.marker.ResendableContentHandle

newHandle, resendableHandleFor

Methods inherited from interface com.marklogic.client.io.marker.BufferableContentHandle

resendableHandleFor

Methods inherited from interface com.marklogic.client.io.marker.ContentHandle

newArray

Constructor Detail

GSONHandle

public GSONHandle()

Zero-argument constructor.

GSONHandle

public GSONHandle(com.google.gson.JsonElement content)

Provides a handle on JSON content as a tree.

Parameters:

content - the JSON root element of the tree.

Method Detail

newFactory

public static ContentHandleFactory newFactory()

Creates a factory to create a GSONHandle instance for a JsonElement node.

Returns:

the factory

newHandle

public GSONHandle newHandle()

Description copied from interface: ContentHandle

Constructs a new handle for the same content representation, initializing the new handle with the same format and mime type.

Specified by:

newHandle in interface BufferableContentHandle<com.google.gson.JsonElement,java.io.InputStream>

Specified by:

newHandle in interface ContentHandle<com.google.gson.JsonElement>

Specified by:

newHandle in interface ResendableContentHandle<com.google.gson.JsonElement,java.io.InputStream>

Returns:

the new handle

newHandleArray

public GSONHandle[] newHandleArray(int length)

Description copied from interface: BufferableContentHandle

Constructs an uninitialized array with the specified length with items of the same content representation.

Specified by:

newHandleArray in interface BufferableContentHandle<com.google.gson.JsonElement,java.io.InputStream>

Specified by:

newHandleArray in interface ResendableContentHandle<com.google.gson.JsonElement,java.io.InputStream>

Parameters:

length - the number of positions in the array

Returns:

the uninitialized array

getParser

@Deprecated
public com.google.gson.JsonParser getParser()

Deprecated. Use static methods like JsonParser.parseString() or JsonParser.parseReader() directly instead

Returns the parser used to construct element objects from JSON.

Returns:

the JSON parser.

get

public com.google.gson.JsonElement get()

Returns the root node of the JSON tree.

Specified by:

get in interface ContentHandle<com.google.gson.JsonElement>

Returns:

the JSON root element.

set

public void set(com.google.gson.JsonElement content)

Assigns a JSON tree as the content.

Specified by:

set in interface ContentHandle<com.google.gson.JsonElement>

Parameters:

content - the JSON root element.

with

public GSONHandle with(com.google.gson.JsonElement content)

Assigns a JSON tree as the content and returns the handle.

Parameters:

content - the JSON root element.

Returns:

the handle on the JSON tree.

getContentClass

public java.lang.Class<com.google.gson.JsonElement> getContentClass()

Description copied from interface: ContentHandle

Returns the class of the handled content, which may be a base class of the actual class of a content object. Note that implementations should override the default method, which returns null if the handle doesn't have any content.

Specified by:

getContentClass in interface ContentHandle<com.google.gson.JsonElement>

Returns:

the class for the handled content

setFormat

public void setFormat(Format format)

Restricts the format to JSON.

Specified by:

setFormat in interface ContentDescriptor

Overrides:

setFormat in class BaseHandle<java.io.InputStream,java.lang.String>

Parameters:

format - the format of the content

fromBuffer

public void fromBuffer(byte[] buffer)

Description copied from interface: BufferableHandle

Sets the content of the handle by copying from a byte array buffer encoded in UTF-8.

Specified by:

fromBuffer in interface BufferableHandle

Parameters:

buffer - the byte array

toBuffer

public byte[] toBuffer()

Description copied from interface: BufferableHandle

Copies the content of the handle to a byte array buffer encoded in UTF-8.

Specified by:

toBuffer in interface BufferableHandle

Returns:

the byte array

bytesToContent

public com.google.gson.JsonElement bytesToContent(byte[] buffer)

Description copied from interface: BufferableContentHandle

Converts a byte serialization to the content representation.

Specified by:

bytesToContent in interface BufferableContentHandle<com.google.gson.JsonElement,java.io.InputStream>

Parameters:

buffer - the byte serialization

Returns:

the content representation

contentToBytes

public byte[] contentToBytes(com.google.gson.JsonElement content)

Description copied from interface: BufferableContentHandle

Converts the content representation to bytes.

Specified by:

contentToBytes in interface BufferableContentHandle<com.google.gson.JsonElement,java.io.InputStream>

Parameters:

content - the content

Returns:

the byte serialization of the content

toString

public java.lang.String toString()

Returns the JSON tree as a string.

Overrides:

toString in class java.lang.Object

toContent

public com.google.gson.JsonElement toContent(java.io.InputStream serialization)

Description copied from interface: BufferableContentHandle

Converts the serialization to the content representation.

Specified by:

toContent in interface BufferableContentHandle<com.google.gson.JsonElement,java.io.InputStream>

Parameters:

serialization - a serialization of the content

Returns:

the content representation

receiveAs

protected java.lang.Class<java.io.InputStream> receiveAs()

Overrides:

receiveAs in class com.marklogic.client.impl.HandleImplementation<java.io.InputStream,java.lang.String>

receiveContent

protected void receiveContent(java.io.InputStream serialization)

Overrides:

receiveContent in class com.marklogic.client.impl.HandleImplementation<java.io.InputStream,java.lang.String>

sendContent

protected java.lang.String sendContent()

Overrides:

sendContent in class com.marklogic.client.impl.HandleImplementation<java.io.InputStream,java.lang.String>