| java.lang.Object
 gnu.lists.SeqPosition
All known Subclasses: gnu.lists.TreePosition,
| SeqPosition | | public class SeqPosition implements java.util.ListIterator,PositionContainer,java.util.Enumeration(Code) | | A position in a sequence (list).
Conceptually similar to Java2's ListIterator, but we use the name "Position"
to indicate that it can be used to both indicate a position in a sequence
and to iterate through a sequence. If you use a SeqPosition as a
"position", you would not modify if (though it is possible the offset
of the position in the sequence may change due to other update operations
on the sequence). If you use a SeqPosition as an "iterator", you would
initialize it to some beginnning position, and then modify the current
position of the SeqPosition so it refers to successive elements.
See the package overview
for more information.
|
| Field Summary | |
| public int | ipos
An integer that (together with xpos) indicates the current position. | | public AbstractSequence | sequence
The Sequence relative to which ipos and xpos have meaning. | | public Object | xpos
An Object that (together with ipos) indicates the current position. |
| Method Summary | |
| public void | add(Object o)
| | public int | countPositions()
Implements PositionContainer. | | public void | finalize()
| | final public int | fromEndIndex()
| | public int | getContainingSequenceSize()
| | public Object | getNext()
Get element following current position. | | public int | getNextKind()
Return a code (defined in Sequence) for the type of the next element. | | public String | getNextTypeName()
Get the "tag name" for the next element, if any. | | public Object | getNextTypeObject()
Get the "tag object" for the next element, if any. | | public int | getPositionInt(int positionNumber)
Implements PositionContainer. | | public Object | getPositionPtr(int positionNumber)
Implements PositionContainer. | | public Object | getPrevious()
| | final public void | gotoEnd(AbstractSequence seq)
| | final public boolean | gotoNext()
Move one element forwards, if possible. | | final public void | gotoStart(AbstractSequence seq)
| | public boolean | hasMoreElements()
True if there is an element following the current position.
False if we are at the end. | | public boolean | hasNext()
See java.util.Iterator. | | public boolean | hasPrevious()
See java.util.Iterator. | | public void | init(AbstractSequence seq, int index, boolean isAfter)
| | public void | init(SeqPosition pos)
| | final public boolean | isAfter()
Does the position pair have the "isAfter" property?
I.e. | | public static SeqPosition | make(AbstractSequence seq, int ipos, Object xpos)
Creates a new SeqPosition, from a position triple. | | public Object | next()
See java.util.ListIterator. | | public Object | nextElement()
See java.util.Enumeration. | | final public int | nextIndex()
See java.util.Iterator. | | public Object | previous()
See java.util.ListIterator. | | final public int | previousIndex()
See java.util.Iterator. | | public void | release()
| | public void | remove()
| | final public void | set(Object value)
| | public void | setPosition(int positionNumber, int ipos, Object xpos)
Implements PositionContainer. | | public void | setSequence(int positionNumber, AbstractSequence seq)
Implements PositionContainer. | | public String | toString()
|
| ipos | | public int ipos(Code) | | An integer that (together with xpos) indicates the current position.
The actual value has no meaning, except as interpreted by sequence.
|
| sequence | | public AbstractSequence sequence(Code) | | The Sequence relative to which ipos and xpos have meaning.
This is normally the same as the Sequence we iterate through.
However, if this is a TreePosition, it may an ancestor instead.
|
| xpos | | public Object xpos(Code) | | An Object that (together with ipos) indicates the current position.
The actual value has no meaning, except as interpreted by sequence.
|
| SeqPosition | | public SeqPosition()(Code) | | |
| countPositions | | public int countPositions()(Code) | | Implements PositionContainer.
|
| finalize | | public void finalize()(Code) | | |
| fromEndIndex | | final public int fromEndIndex()(Code) | | |
| getContainingSequenceSize | | public int getContainingSequenceSize()(Code) | | |
| getNext | | public Object getNext()(Code) | | Get element following current position.
Does not move the position, in contrast to nextElement method.
EOF if at end of sequence, otherwise the value following. |
| getNextKind | | public int getNextKind()(Code) | | Return a code (defined in Sequence) for the type of the next element.
|
| getNextTypeName | | public String getNextTypeName()(Code) | | Get the "tag name" for the next element, if any.
|
| getNextTypeObject | | public Object getNextTypeObject()(Code) | | Get the "tag object" for the next element, if any.
|
| getPositionInt | | public int getPositionInt(int positionNumber)(Code) | | Implements PositionContainer.
|
| getPositionPtr | | public Object getPositionPtr(int positionNumber)(Code) | | Implements PositionContainer.
|
| gotoNext | | final public boolean gotoNext()(Code) | | Move one element forwards, if possible.
|
| hasMoreElements | | public boolean hasMoreElements()(Code) | | True if there is an element following the current position.
False if we are at the end. See java.util.Enumeration.
|
| hasNext | | public boolean hasNext()(Code) | | See java.util.Iterator.
|
| hasPrevious | | public boolean hasPrevious()(Code) | | See java.util.Iterator.
|
| isAfter | | final public boolean isAfter()(Code) | | Does the position pair have the "isAfter" property?
I.e. if something is inserted at the position, will
the iterator end up being after the new data?
A toNext() or next() command should set isAfter() to true;
a toPrevious or previous command should set isAfter() to false.
|
| nextIndex | | final public int nextIndex()(Code) | | See java.util.Iterator.
|
| previous | | public Object previous()(Code) | | See java.util.ListIterator.
|
| previousIndex | | final public int previousIndex()(Code) | | See java.util.Iterator.
|
| release | | public void release()(Code) | | |
| remove | | public void remove()(Code) | | |
| setPosition | | public void setPosition(int positionNumber, int ipos, Object xpos)(Code) | | Implements PositionContainer.
|
| setSequence | | public void setSequence(int positionNumber, AbstractSequence seq)(Code) | | Implements PositionContainer.
|
|
|