public class

DocSnapshot

extends Object
implements AutoCloseable
java.lang.Object
   ↳ com.pdftron.sdf.DocSnapshot

Class Overview

The class DocSnapshot. Represents a state of the document.

Summary

Public Constructors
DocSnapshot(long impl_ptr)
Public Methods
long __GetHandle()
void close()
Frees the native memory of the object.
void destroy()
Frees the native memory of the object.
boolean equals(DocSnapshot snapshot)
Returns whether this snapshot's document state is equivalent to another.
int getHash()
Returns a hash that is unique to particular document states.
boolean isValid()
Returns whether this snapshot is valid.
[Expand]
Inherited Methods
From class java.lang.Object
From interface java.lang.AutoCloseable

Public Constructors

public DocSnapshot (long impl_ptr)

Public Methods

public long __GetHandle ()

public void close ()

Frees the native memory of the object. This can be explicity called to control the deallocation of native memory and avoid situations where the garbage collector does not free the object in a timely manner.

public void destroy ()

Frees the native memory of the object. This can be explicity called to control the deallocation of native memory and avoid situations where the garbage collector does not free the object in a timely manner.

public boolean equals (DocSnapshot snapshot)

Returns whether this snapshot's document state is equivalent to another.

Parameters
snapshot -- the other snapshot with which to compare.
Returns
  • Whether this snapshot's document state is equivalent to another.

public int getHash ()

Returns a hash that is unique to particular document states.

Returns
  • A hash that is unique to particular document states.

public boolean isValid ()

Returns whether this snapshot is valid.

Returns
  • Whether this snapshot is valid.