Class BaseHandle<R,W>

Type Parameters:

R - a read handle or OperationNotSupported in the com.marklogic.client.io.marker package

W - a write handle or OperationNotSupported in the com.marklogic.client.io.marker package

All Implemented Interfaces:

ContentDescriptor

Direct Known Subclasses:

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

• Field Summary

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

  UNKNOWN_LENGTH

• Constructor Summary

  Constructors
  Constructor

  Description

  BaseHandle()

  Zero-argument constructor.

• Method Summary

  All MethodsInstance MethodsConcrete Methods

  Modifier and Type

  Method

  Description

  long

  getByteLength()

  Returns the length of the content in bytes as returned by the server.

  Format

  getFormat()

  Returns the format of the content.

  String

  getMimetype()

  Returns the mimetype of the content.

  long

  getServerTimestamp()

   

  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(String mimetype)

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

  void

  setServerTimestamp(long serverTimestamp)

   

  Methods inherited from class com.marklogic.client.impl.HandleImplementation

  getPointInTimeQueryTimestamp, isResendable, receiveAs, receiveContent, sendContent, setPointInTimeQueryTimestamp, setResendable, setResponseServerTimestamp

  Methods inherited from class java.lang.Object

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

• Constructor Details

  • BaseHandle

    public BaseHandle()
    Zero-argument constructor.

• Method Details

  • getFormat

    public Format getFormat()
    Description copied from interface: ContentDescriptor
    Returns the format of the content.

    Returns:

    the content format

  • setFormat

    public void setFormat(Format format)
    Description copied from interface: ContentDescriptor
    Specifies the format of the content as binary, JSON, text, or XML.

    Parameters:

    format - the format of the content

  • getMimetype

    public String getMimetype()
    Description copied from interface: ContentDescriptor
    Returns the mimetype of the content.

    Returns:

    the content mimetype

  • setMimetype

    public void setMimetype(String mimetype)
    Description copied from interface: ContentDescriptor
    Specifies the mimetype of the content such as application/json, text/plain, or application/xml.

    Parameters:

    mimetype - the content mimetype

  • getServerTimestamp

    public long getServerTimestamp()

    Overrides:

    getServerTimestamp in class com.marklogic.client.impl.HandleImplementation<R,W>

  • setServerTimestamp

    public void setServerTimestamp(long serverTimestamp)

  • getByteLength

    public long getByteLength()
    Description copied from interface: ContentDescriptor
    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

    public void setByteLength(long length)
    Description copied from interface: ContentDescriptor
    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

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