Class Export

java.lang.Object
io.deephaven.client.impl.Export
All Implemented Interfaces:
HasExportId, HasPathId, HasTicketId, HasTypedTicket, AutoCloseable

public final class Export extends Object implements AutoCloseable, HasExportId
An export represents a server-side Table that is being kept alive.

Callers must maintain ownership of their exports, and close them when no longer needed.

See Also:
  • Method Details

    • exportId

      public ExportId exportId()
      Description copied from interface: HasExportId
      Get the export ID.
      Specified by:
      exportId in interface HasExportId
      Returns:
      the export ID
    • typedTicket

      public TypedTicket typedTicket()
      Description copied from interface: HasTypedTicket
      Get the typed ticket.
      Specified by:
      typedTicket in interface HasTypedTicket
      Returns:
      the typed ticket
    • pathId

      public PathId pathId()
      Description copied from interface: HasPathId
      Get the path ID.
      Specified by:
      pathId in interface HasPathId
      Returns:
      the path ID
    • ticketId

      public TicketId ticketId()
      Description copied from interface: HasTicketId
      Get the ticket ID.
      Specified by:
      ticketId in interface HasTicketId
      Returns:
      the ticket ID
    • session

      public Session session()
      The session.
      Returns:
      the session
    • table

      public TableSpec table()
      The table spec.
      Returns:
      the table spec
    • isReleased

      public boolean isReleased()
      True if this has been released.
      Returns:
      true if released
    • newReference

      public Export newReference(io.deephaven.client.impl.ExportRequest.Listener listener)
      Creates a new reference export that has its own ownership and lifecycle. Must not be called after this export has been released.
      Parameters:
      listener - the listener
      Returns:
      the new reference export
    • release

      public boolean release()
      Releases this export. May be called multiple times without adverse effect.
    • close

      public void close()
      Specified by:
      close in interface AutoCloseable
      See Also:
    • toString

      public String toString()
      Overrides:
      toString in class Object
    • toReadableString

      public String toReadableString()