Class QueryOptionsListHandle

All Implemented Interfaces:

ContentDescriptor, AbstractReadHandle, QueryOptionsListReadHandle, QueryOptionsListResults

• Field Summary

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

  UNKNOWN_LENGTH

• Constructor Summary

  Constructors
  Constructor

  Description

  QueryOptionsListHandle()

  The constructor.

• Method Summary

  All MethodsInstance MethodsConcrete Methods

  Modifier and Type

  Method

  Description

  HashMap<String,String>

  getValuesMap()

  Returns a HashMap of the named query options from the server.

  protected Class<InputStream>

  receiveAs()

   

  protected void

  receiveContent(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 Details

  • QueryOptionsListHandle

    public QueryOptionsListHandle()
    The constructor.

• Method Details

  • 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<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 Class<InputStream> receiveAs()

    Overrides:

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

  • receiveContent

    protected void receiveContent(InputStream content)

    Overrides:

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

  • getValuesMap

    public HashMap<String,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.

Copyright (c) 2010-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.