com.marklogic.client.query.ExtractedItem Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of marklogic-client-api Show documentation

The official MarkLogic Java client API.

The newest version!

/*
 * Copyright © 2024 MarkLogic Corporation. All Rights Reserved.
 */
package com.marklogic.client.query;

import com.marklogic.client.io.marker.StructureReadHandle;

/** Access the extracted XML or JSON node using any StructureReadHandle
 * or class registered by a ContentHandle. */
public interface ExtractedItem {
  /** Get the item using the specified handle.
   * @param handle a handle to populate
   * @param  the type of StructureReadHandle to return
   * @return the item represented by this instance
   */
   T get(T handle);

  /** Get the item using the handle registered for the specified class.
   * The IO class must have been registered before creating the database client.
   * By default, the provided handles that implement
   * {@link com.marklogic.client.io.marker.ContentHandle ContentHandle} are registered.
   *
   * Learn more about shortcut methods
   *
   * @param as a Class type that has been registered by a handle
   * @param  the type of object that will be returned by the handle registered for it
   * @return the item represented by this instance
   */
   T getAs(Class as);
}