public class BookMark
extends java.lang.Object
Constructor and Description |
---|
BookMark()
Constructor for BookMark
Take no argument
|
BookMark(VTDNav vn)
BookMark constructor with an instance of vn
as input
|
Modifier and Type | Method and Description |
---|---|
void |
bind(VTDNav vn)
bind a BookMark object to a VTDNav object
the cursor position is set to an invalid state
|
boolean |
compare(BookMark bm1)
Compare the node positions of two bookMarks
|
boolean |
deepEquals(BookMark bm2)
Compare the bookmarks to ensure they represent the same
node in the same VTDnav instance
|
boolean |
equals(BookMark bm2)
Compare the bookmarks to ensure they represent the same
node in the same VTDnav instance
|
boolean |
equals(java.lang.Object obj)
Compare two bookmarks to ensure they represent the same
node in the same VTDnav instance
|
VTDNav |
getNav()
This method returns the embedded VTDNav Object
|
int |
hashCode()
Returns the hash code which is a unique integer for every node
|
boolean |
recordCursorPosition()
Record cursor position of the VTDNav object as embedded in the
bookmark
|
boolean |
recordCursorPosition(VTDNav vn)
Record the cursor position
This method is implemented to be lenient on loading in
that it can load nodes from any VTDNav object
if vn is null, return false
|
boolean |
setCursorPosition()
Set the cursor position of VTDNav object corresponding to the internal reference
position of the embedded VTDNav object
|
boolean |
setCursorPosition(VTDNav vn)
set cursor position
This method can only set the cursor position
of an VTDNav object identical to its internal copy
|
void |
unbind()
separate a bookMark object apart from its embedded
VTDNav instance
|
public BookMark()
public BookMark(VTDNav vn)
vn
- public void bind(VTDNav vn)
vn
- public boolean compare(BookMark bm1)
bm1
- public final boolean deepEquals(BookMark bm2)
bm2
- public final boolean equals(BookMark bm2)
bm2
- public final boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public final VTDNav getNav()
public final int hashCode()
hashCode
in class java.lang.Object
public final boolean recordCursorPosition()
public boolean recordCursorPosition(VTDNav vn)
vn
- public final boolean setCursorPosition()
public boolean setCursorPosition(VTDNav vn)
vn
- public final void unbind()