|
OpenOffice.org XMerge API |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
This is an interface used by the DiffAlgorithm
and MergeAlgorithm
to access a Document
.
Method Summary | |
java.lang.Object |
currentElement()
Return the current element Object content. |
int |
elementCount()
Return the total element count in the sequence. |
java.lang.Object |
end()
Move to the end of the sequence. |
boolean |
equivalent(java.lang.Object obj1,
java.lang.Object obj2)
A method to allow the difference algorithm to test whether the obj1 and obj2 in the
Iterator are considered equal. |
java.lang.Object |
next()
Move to next element in the sequence. |
java.lang.Object |
previous()
Move to previous element in the sequence. |
void |
refresh()
A method to force the Iterator to transverse the tree
again to refresh the content. |
java.lang.Object |
start()
Move to the beginning of the sequence. |
Method Detail |
public java.lang.Object currentElement()
Object
content.Object
at current position.public int elementCount()
public java.lang.Object end()
Object
of the last element in the sequence.
If it is empty, then return null.public boolean equivalent(java.lang.Object obj1, java.lang.Object obj2)
obj1
and obj2
in the
Iterator
are considered equal. As not every
Object
in the Iterator
can implement its
own equal method, with this equivalent method, we can allow
flexibility for the Iterator
to choose a custom way
to compare two objects. Two objects can even be compared based on
the position in the Iterator
rather than by
the content via this option.obj1
- The first Object
.obj2
- The second Object
.public java.lang.Object next()
Object
of the next element in the sequence.
If there is no next element, then return null.public java.lang.Object previous()
Object
of the previous element in the sequence.
If there is no previous element, then return null.public void refresh()
A method to force the Iterator
to transverse the tree
again to refresh the content.
It is used mainly for Iterator
objects which take a snap
shot instead of dynamically transversing the tree. The current
position will be set to the beginning.
public java.lang.Object start()
Object
of the first element in the sequence.
If it is empty, then return null.
|
OpenOffice.org XMerge API |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |