com.yworks.yfiles.algorithms

Interface ICursor

All Known Subinterfaces:

IEdgeCursor, ILineSegmentCursor, INodeCursor, IPointCursor

public interface ICursor

A general interface for iterating over a collection of objects.

It can be regarded as a read-only view of such a collection.

A YCursor acts like a movable pointer on the elements of a collection. The pointer can be moved forward and backward and the element currently pointed on can be accessed. The removal of elements can only be performed on the provider of the cursor, not on the cursor itself. (That's why the cursor presents a read-only view.)

Implementations of this interface do not need to support operations marked "optional."

Method Summary

Modifier and Type	Method and Description
Object	current() Gets the object currently pointed on.
void	next() Moves this cursor one position forward.
boolean	ok() Gets true if the current cursor position is valid.
void	prev() Moves this cursor one position backward (optional).
int	size() Gets the number of elements that can be accessed with this cursor.
void	toFirst() Moves this cursor to the first valid cursor position (optional).
void	toLast() Moves this cursor to the last valid cursor position (optional).

Method Detail

current

Object current()

Gets the object currently pointed on.

Returns:

The Current.

next

void next()

Moves this cursor one position forward.

ok

boolean ok()

Gets true if the current cursor position is valid.

Returns:

The Ok.

prev

void prev()

Moves this cursor one position backward (optional).

size

int size()

Gets the number of elements that can be accessed with this cursor.

Returns:

The Size.

toFirst

void toFirst()

Moves this cursor to the first valid cursor position (optional).

toLast

void toLast()

Moves this cursor to the last valid cursor position (optional).