Package com.marklogic.client.io

Class QueryOptionsListHandle

java.lang.Object

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

com.marklogic.client.io.BaseHandle<java.io.InputStream,OperationNotSupported>

com.marklogic.client.io.QueryOptionsListHandle

All Implemented Interfaces:

ContentDescriptor, AbstractReadHandle, QueryOptionsListReadHandle, QueryOptionsListResults

public class QueryOptionsListHandle
extends BaseHandle<java.io.InputStream,OperationNotSupported>
implements QueryOptionsListReadHandle, QueryOptionsListResults

A QueryOptionsListHandle is used to access the list of named query options that exist on the server.

Field Summary

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

UNKNOWN_LENGTH

Constructor Summary

Constructors

Constructor	Description
QueryOptionsListHandle()	The constructor.

Method Summary

Modifier and Type	Method	Description
java.util.HashMap<java.lang.String,java.lang.String>	getValuesMap()	Returns a HashMap of the named query options from the server.
protected java.lang.Class<java.io.InputStream>	receiveAs()
protected void	receiveContent(java.io.InputStream content)
void	setFormat(Format format)	Sets the format associated with this handle.
QueryOptionsListHandle	withFormat(Format format)	Fluent setter for the format associated with this 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, sendContent, setPointInTimeQueryTimestamp, setResendable, setResponseServerTimestamp

Methods inherited from class java.lang.Object

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

Constructor Detail

QueryOptionsListHandle

public QueryOptionsListHandle()

The constructor.

Method Detail

setFormat

public void setFormat(Format format)

Sets the format associated with this handle. This handle only supports XML.

Specified by:

setFormat in interface ContentDescriptor

Overrides:

setFormat in class BaseHandle<java.io.InputStream,OperationNotSupported>

Parameters:

format - The format, which must be Format.XML or an exception will be raised.

withFormat

public QueryOptionsListHandle withFormat(Format format)

Fluent setter for the format associated with this handle. This handle only supports XML.

Parameters:

format - The format, which must be Format.XML or an exception will be raised.

Returns:

The QueryOptionsListHandle instance on which this method was called.

receiveAs

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

Overrides:

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

receiveContent

protected void receiveContent(java.io.InputStream content)

Overrides:

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

getValuesMap

public java.util.HashMap<java.lang.String,java.lang.String> getValuesMap()

Returns a HashMap of the named query options from the server. The keys are the names of the query options, the values are the corresponding URIs on the server.

Specified by:

getValuesMap in interface QueryOptionsListResults

Returns:

The map of names to URIs.