com.marklogic.client.io.marker

Interface ContentHandle<C>

All Superinterfaces:

AbstractReadHandle, AbstractWriteHandle

All Known Subinterfaces:

BufferableContentHandle<C,R>, ResendableContentHandle<C,R>, StreamingContentHandle<C,R>

All Known Implementing Classes:

BytesHandle, DOM4JHandle, DOMHandle, FileHandle, GSONHandle, InputSourceHandle, InputStreamHandle, JacksonDatabindHandle, JacksonHandle, JacksonParserHandle, JAXBHandle, JDOMHandle, ReaderHandle, SourceHandle, StringHandle, XMLEventReaderHandle, XMLStreamReaderHandle

public interface ContentHandle<C>
extends AbstractReadHandle, AbstractWriteHandle

A Content Handle provides get / set access to a representation of content such a byte[] array, input stream, file, reader, string, and so on.

Method Summary

Modifier and Type	Method and Description
C	get() Returns the content.
default java.lang.Class<C>	getContentClass() Returns the class of the handled content, which may be a base class of the actual class of a content object.
default C[]	newArray(int length) Constructs an array for the handled content representation
default ContentHandle<C>	newHandle() Constructs a new handle for the same content representation, initializing the new handle with the same format and mime type.
default ContentHandle<C>	newHandle(C content) Constructs a new handle for the same content representation, initializing the new handle with the same format and mime type and new content.
void	set(C content) Assigns the content.

Method Detail

get

C get()

Returns the content.

Returns:

the content

set

void set(C content)

Assigns the content.

Parameters:

content - the content

getContentClass

default java.lang.Class<C> getContentClass()

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.

Returns:

the class for the handled content

newHandle

default ContentHandle<C> newHandle()

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

Returns:

the new handle

newHandle

default ContentHandle<C> newHandle(C content)

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

Parameters:

content - the new content to initialize the new handle

Returns:

the new handle

newArray

default C[] newArray(int length)

Constructs an array for the handled content representation

Parameters:

length - the size of the array (zero or more)

Returns:

the constructed array