com.marklogic.client.document

Interface ContentDescriptor

All Known Subinterfaces:

DocumentDescriptor, DocumentUriTemplate, TemporalDescriptor

All Known Implementing Classes:

BaseHandle, BytesHandle, DocumentMetadataHandle, DOM4JHandle, DOMHandle, FileHandle, GSONHandle, com.marklogic.client.impl.HandleImplementation, InputSourceHandle, InputStreamHandle, com.marklogic.client.impl.JacksonBaseHandle, JacksonDatabindHandle, JacksonHandle, JacksonParserHandle, JAXBHandle, JDOMHandle, OutputStreamHandle, QueryOptionsListHandle, ReaderHandle, RuleDefinition, RuleDefinitionList, SearchHandle, SourceHandle, StringHandle, TuplesHandle, ValuesHandle, ValuesListHandle, XMLEventReaderHandle, XMLStreamReaderHandle

public interface ContentDescriptor

A Content Descriptor identifies the properties of some content.

Field Summary

Fields

Modifier and Type	Field and Description
static long	UNKNOWN_LENGTH Indicates that the length of the content is not known.

Method Summary

Modifier and Type	Method and Description
long	getByteLength() Returns the length of the content in bytes as returned by the server.
Format	getFormat() Returns the format of the content.
java.lang.String	getMimetype() Returns the mimetype of the content.
void	setByteLength(long length) Specifies the length of the content in bytes or the UNKNOWN_LENGTH constant if the length of the content is not known.
void	setFormat(Format format) Specifies the format of the content as binary, JSON, text, or XML.
void	setMimetype(java.lang.String mimetype) Specifies the mimetype of the content such as application/json, text/plain, or application/xml.

Field Detail

UNKNOWN_LENGTH

static final long UNKNOWN_LENGTH

Indicates that the length of the content is not known.

See Also:

Constant Field Values

Method Detail

getFormat

Format getFormat()

Returns the format of the content.

Returns:

the content format

setFormat

void setFormat(Format format)

Specifies the format of the content as binary, JSON, text, or XML.

Parameters:

format - the format of the content

getMimetype

java.lang.String getMimetype()

Returns the mimetype of the content.

Returns:

the content mimetype

setMimetype

void setMimetype(java.lang.String mimetype)

Specifies the mimetype of the content such as application/json, text/plain, or application/xml.

Parameters:

mimetype - the content mimetype

getByteLength

long getByteLength()

Returns the length of the content in bytes as returned by the server. This value is usually not set when reading from a local source (such as a file or an input stream). The byte length won't be returned by the server for very large documents for performance reasons. The byte length can be larger than the character length if the content contains multi-byte characters.

Returns:

the content length in bytes

setByteLength

void setByteLength(long length)

Specifies the length of the content in bytes or the UNKNOWN_LENGTH constant if the length of the content is not known.

Parameters:

length - the content length in bytes