com.marklogic.client.extra.gson

Class GSONHandle

java.lang.Object

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

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

com.marklogic.client.extra.gson.GSONHandle

All Implemented Interfaces:

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

public class GSONHandle
extends BaseHandle<InputStream,String>
implements BufferableHandle, ContentHandle<com.google.gson.JsonElement>, 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
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.
com.google.gson.JsonParser	getParser() Returns the parser used to construct element objects from JSON.
static ContentHandleFactory	newFactory() Creates a factory to create a GSONHandle instance for a JsonElement node.
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.
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, setPointInTimeQueryTimestamp, setResponseServerTimestamp

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

getParser

public com.google.gson.JsonParser getParser()

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.

setFormat

public void setFormat(Format format)

Restricts the format to JSON.

Specified by:

setFormat in interface ContentDescriptor

Overrides:

setFormat in class BaseHandle<InputStream,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

toString

public String toString()

Returns the JSON tree as a string.

Overrides:

toString in class Object