Class JacksonHandle

All Implemented Interfaces:

ContentDescriptor, AbstractReadHandle, AbstractWriteHandle, BufferableContentHandle<com.fasterxml.jackson.databind.JsonNode,InputStream>, BufferableHandle, ContentHandle<com.fasterxml.jackson.databind.JsonNode>, CtsQueryWriteHandle, DocumentMetadataReadHandle, DocumentMetadataWriteHandle, DocumentPatchHandle, JSONReadHandle, JSONWriteHandle, QueryOptionsListReadHandle, QueryOptionsReadHandle, QueryOptionsWriteHandle, ResendableContentHandle<com.fasterxml.jackson.databind.JsonNode,InputStream>, RuleListReadHandle, RuleReadHandle, RuleWriteHandle, SearchReadHandle, SPARQLResultsReadHandle, StructureReadHandle, StructureWriteHandle, TriplesReadHandle, TriplesWriteHandle, TuplesReadHandle, ValuesListReadHandle, ValuesReadHandle, OutputStreamSender

• Field Summary

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

  UNKNOWN_LENGTH

• Constructor Summary

  Constructors
  Constructor

  Description

  JacksonHandle()

  Zero-argument constructor.

  JacksonHandle(com.fasterxml.jackson.databind.JsonNode content)

  Provides a handle on JSON content as a Jackson tree.

• Method Summary

  All MethodsStatic MethodsInstance MethodsConcrete Methods

  Modifier and Type

  Method

  Description

  com.fasterxml.jackson.databind.JsonNode

  get()

  Returns the root node of the JSON tree.

  Class<com.fasterxml.jackson.databind.JsonNode>

  getContentClass()

  Returns the class of the handled content, which may be a base class of the actual class of a content object.

  protected boolean

  hasContent()

   

  com.fasterxml.jackson.databind.JsonNode[]

  newArray(int length)

  Constructs an array for the handled content representation

  static ContentHandleFactory

  newFactory()

  Creates a factory to create a JacksonHandle instance for a JSON node.

  JacksonHandle

  newHandle()

  Constructs a new handle for the same content representation, initializing the new handle with the same format and mime type.

  JacksonHandle[]

  newHandleArray(int length)

  Constructs an uninitialized array with the specified length with items of the same content representation.

  protected void

  receiveContent(InputStream content)

   

  protected OutputStreamSender

  sendContent()

   

  protected OutputStreamSender

  sendContent(com.fasterxml.jackson.databind.JsonNode content)

   

  void

  set(com.fasterxml.jackson.databind.JsonNode content)

  Assigns a JSON tree as the content.

  com.fasterxml.jackson.databind.JsonNode

  toContent(InputStream serialization)

  Converts the serialization to the content representation.

  JacksonHandle

  with(com.fasterxml.jackson.databind.JsonNode content)

  Assigns a JSON tree as the content and returns the handle.

  JacksonHandle

  withFormat(Format format)

  Specifies the format of the content and returns the handle as a fluent convenience.

  JacksonHandle

  withMimetype(String mimetype)

  Specifies the mime type of the content and returns the handle as a fluent convenience.

  void

  write(OutputStream out)

  Implements a callback to write content to the provided output stream for sending to the database server.

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

  bytesToContent, contentToBytes, fromBuffer, getMapper, receiveAs, setMapper, toBuffer, toString

  Methods inherited from class com.marklogic.client.io.BaseHandle

  getByteLength, getFormat, getMimetype, getServerTimestamp, setByteLength, setFormat, setMimetype, setServerTimestamp

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

  getPointInTimeQueryTimestamp, isResendable, setPointInTimeQueryTimestamp, setResendable, setResponseServerTimestamp

  Methods inherited from class java.lang.Object

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

  Methods inherited from interface com.marklogic.client.io.marker.BufferableContentHandle

  bytesToContent, contentToBytes, resendableHandleFor

  Methods inherited from interface com.marklogic.client.io.marker.BufferableHandle

  fromBuffer, toBuffer

  Methods inherited from interface com.marklogic.client.io.marker.ResendableContentHandle

  newHandle, resendableHandleFor

• Constructor Details

  • JacksonHandle

    public JacksonHandle()
    Zero-argument constructor.

  • JacksonHandle

    public JacksonHandle(com.fasterxml.jackson.databind.JsonNode content)
    Provides a handle on JSON content as a Jackson tree.

    Parameters:

    content - the JSON root node of the tree.

• Method Details

  • newFactory

    public static ContentHandleFactory newFactory()
    Creates a factory to create a JacksonHandle instance for a JSON node.

    Returns:

    the factory

  • withFormat

    public JacksonHandle withFormat(Format format)
    Specifies the format of the content and returns the handle as a fluent convenience.

    Parameters:

    format - the format of the content

    Returns:

    this handle

  • withMimetype

    public JacksonHandle withMimetype(String mimetype)
    Specifies the mime type of the content and returns the handle as a fluent convenience.

    Parameters:

    mimetype - the mime type of the content

    Returns:

    this handle

  • get

    public com.fasterxml.jackson.databind.JsonNode get()
    Returns the root node of the JSON tree.

    Specified by:

    get in interface ContentHandle<com.fasterxml.jackson.databind.JsonNode>

    Specified by:

    get in class com.marklogic.client.impl.JacksonBaseHandle<com.fasterxml.jackson.databind.JsonNode>

    Returns:

    the JSON root node.

  • set

    public void set(com.fasterxml.jackson.databind.JsonNode content)
    Assigns a JSON tree as the content.

    Specified by:

    set in interface ContentHandle<com.fasterxml.jackson.databind.JsonNode>

    Specified by:

    set in class com.marklogic.client.impl.JacksonBaseHandle<com.fasterxml.jackson.databind.JsonNode>

    Parameters:

    content - the JSON root node.

  • with

    public JacksonHandle with(com.fasterxml.jackson.databind.JsonNode content)
    Assigns a JSON tree as the content and returns the handle.

    Parameters:

    content - the JSON root node.

    Returns:

    the handle on the JSON tree.

  • getContentClass

    public Class<com.fasterxml.jackson.databind.JsonNode> getContentClass()
    Description copied from interface: ContentHandle
    Returns the class of the handled content, which may be a base class of the actual class of a content object. Note that implementations should override the default method, which returns null if the handle doesn't have any content.

    Specified by:

    getContentClass in interface ContentHandle<com.fasterxml.jackson.databind.JsonNode>

    Returns:

    the class for the handled content

  • newHandle

    public JacksonHandle newHandle()
    Description copied from interface: ContentHandle
    Constructs a new handle for the same content representation, initializing the new handle with the same format and mime type.

    Specified by:

    newHandle in interface BufferableContentHandle<com.fasterxml.jackson.databind.JsonNode,InputStream>

    Specified by:

    newHandle in interface ContentHandle<com.fasterxml.jackson.databind.JsonNode>

    Specified by:

    newHandle in interface ResendableContentHandle<com.fasterxml.jackson.databind.JsonNode,InputStream>

    Returns:

    the new handle

  • newHandleArray

    public JacksonHandle[] newHandleArray(int length)
    Description copied from interface: BufferableContentHandle
    Constructs an uninitialized array with the specified length with items of the same content representation.

    Specified by:

    newHandleArray in interface BufferableContentHandle<com.fasterxml.jackson.databind.JsonNode,InputStream>

    Specified by:

    newHandleArray in interface ResendableContentHandle<com.fasterxml.jackson.databind.JsonNode,InputStream>

    Parameters:

    length - the number of positions in the array

    Returns:

    the uninitialized array

  • newArray

    public com.fasterxml.jackson.databind.JsonNode[] newArray(int length)
    Description copied from interface: ContentHandle
    Constructs an array for the handled content representation

    Specified by:

    newArray in interface ContentHandle<com.fasterxml.jackson.databind.JsonNode>

    Parameters:

    length - the size of the array (zero or more)

    Returns:

    the constructed array

  • toContent

    public com.fasterxml.jackson.databind.JsonNode toContent(InputStream serialization)
    Description copied from interface: BufferableContentHandle
    Converts the serialization to the content representation.

    Specified by:

    toContent in interface BufferableContentHandle<com.fasterxml.jackson.databind.JsonNode,InputStream>

    Specified by:

    toContent in class com.marklogic.client.impl.JacksonBaseHandle<com.fasterxml.jackson.databind.JsonNode>

    Parameters:

    serialization - a serialization of the content

    Returns:

    the content representation

  • sendContent

    protected OutputStreamSender sendContent(com.fasterxml.jackson.databind.JsonNode content)

    Specified by:

    sendContent in class com.marklogic.client.impl.JacksonBaseHandle<com.fasterxml.jackson.databind.JsonNode>

  • sendContent

    protected OutputStreamSender sendContent()

    Overrides:

    sendContent in class com.marklogic.client.impl.HandleImplementation<InputStream,OutputStreamSender>

  • receiveContent

    protected void receiveContent(InputStream content)

    Overrides:

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

  • hasContent

    protected boolean hasContent()

    Specified by:

    hasContent in class com.marklogic.client.impl.JacksonBaseHandle<com.fasterxml.jackson.databind.JsonNode>

  • write

    public void write(OutputStream out) throws IOException
    Description copied from interface: OutputStreamSender
    Implements a callback to write content to the provided output stream for sending to the database server.

    Specified by:

    write in interface OutputStreamSender

    Parameters:

    out - the output stream receiving the content

    Throws:

    IOException - if io problems arise

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