| Package | Description |
|---|---|
| com.marklogic.client.admin |
The package provides the classes for configuration and initialization
of the REST server.
|
| com.marklogic.client.document |
The package provides classes for creating, retrieving, updating, and deleting
documents in the database for the REST server.
|
| com.marklogic.client.example.handle |
The package provides examples of extensions that read or write database documents
in a new way or with a new representation.
|
| com.marklogic.client.extensions |
The package provides base and support classes so you can derive
a new Resource Manager to provide a client interface for a
Resource Services extension on the REST server.
|
| com.marklogic.client.io |
The package provides the handle classes with different representations for document content
when you read documents from the database or write documents to the database.
|
| Modifier and Type | Method and Description |
|---|---|
Format |
ServerConfigurationManager.getErrorFormat()
Returns the configured error format for the REST server instance.
|
| Modifier and Type | Method and Description |
|---|---|
void |
ServerConfigurationManager.setErrorFormat(Format errorFormat)
Sets the serialization format of MarkLogic errors.
|
| Modifier and Type | Method and Description |
|---|---|
Format |
DocumentManager.getContentFormat()
Gets the format of the managed documents
|
Format |
ContentDescriptor.getFormat()
Returns the format of the content.
|
| Modifier and Type | Method and Description |
|---|---|
void |
ContentDescriptor.setFormat(Format format)
Specifies the format of the content as binary, JSON, text, or XML.
|
| Modifier and Type | Method and Description |
|---|---|
void |
XOMHandle.setFormat(Format format) |
void |
JDOMHandle.setFormat(Format format) |
void |
JacksonHandle.setFormat(Format format) |
void |
HTMLCleanerHandle.setFormat(Format format) |
void |
DOM4JHandle.setFormat(Format format) |
URIHandle |
URIHandle.withFormat(Format format) |
| Modifier and Type | Method and Description |
|---|---|
Format |
ResourceServices.ServiceResult.getFormat()
Returns the format of the content.
|
| Modifier and Type | Method and Description |
|---|---|
Format |
QueryOptionsHandle.getFormat()
Returns the underlying format supported by the query options handle.
|
Format |
BaseHandle.getFormat() |
static Format |
Format.valueOf(String name)
Returns the enum constant of this type with the specified name.
|
static Format[] |
Format.values()
Returns an array containing the constants of this enum type, in
the order they are declared.
|
| Modifier and Type | Method and Description |
|---|---|
void |
XMLStreamReaderHandle.setFormat(Format format)
Restricts the format to XML.
|
void |
XMLEventReaderHandle.setFormat(Format format)
Restricts the format to XML.
|
void |
ValuesListHandle.setFormat(Format format)
Sets the format associated with this handle.
|
void |
ValuesHandle.setFormat(Format format)
Sets the format associated with this handle.
|
void |
TuplesHandle.setFormat(Format format)
Sets the format associated with this handle.
|
void |
SourceHandle.setFormat(Format format)
Restricts the format to XML.
|
void |
SearchHandle.setFormat(Format format)
Sets the format associated with this handle.
|
void |
QueryOptionsListHandle.setFormat(Format format)
Sets the format associated with this handle.
|
void |
QueryOptionsHandle.setFormat(Format format)
Set the format accepted by this handle.
|
void |
JAXBHandle.setFormat(Format format)
Restricts the format to XML.
|
void |
InputSourceHandle.setFormat(Format format)
Restricts the format to XML.
|
void |
DOMHandle.setFormat(Format format)
Restricts the format to XML.
|
void |
DocumentMetadataHandle.setFormat(Format format)
Restricts the format used parsing and serializing the metadata.
|
void |
BaseHandle.setFormat(Format format) |
ValuesListHandle |
ValuesListHandle.withFormat(Format format)
Fluent setter for the format associated with this handle.
|
ValuesHandle |
ValuesHandle.withFormat(Format format)
Fluent setter for the format associated with this handle.
|
TuplesHandle |
TuplesHandle.withFormat(Format format)
Fluent setter for the format associated with this handle.
|
StringHandle |
StringHandle.withFormat(Format format)
Specifies the format of the content and returns the handle
as a fluent convenience.
|
SearchHandle |
SearchHandle.withFormat(Format format)
Fluent setter for the format associated with this handle.
|
ReaderHandle |
ReaderHandle.withFormat(Format format)
Specifies the format of the content and returns the handle
as a fluent convenience.
|
QueryOptionsListHandle |
QueryOptionsListHandle.withFormat(Format format)
Fluent setter for the format associated with this handle.
|
OutputStreamHandle |
OutputStreamHandle.withFormat(Format format)
Specifies the format of the content and returns the handle
as a fluent convenience.
|
InputStreamHandle |
InputStreamHandle.withFormat(Format format)
Specifies the format of the content and returns the handle
as a fluent convenience.
|
FileHandle |
FileHandle.withFormat(Format format)
Specifies the format of the content and returns the handle
as a fluent convenience.
|
BytesHandle |
BytesHandle.withFormat(Format format)
Specifies the format of the content and returns the handle
as a fluent convenience.
|
Copyright © 2013-2014 MarkLogic Corporation.