org.apache.giraph.utils

Interface VertexIdIterator<I extends org.apache.hadoop.io.WritableComparable>

Type Parameters:

I - Vertex id

All Known Subinterfaces:

VertexIdDataIterator<I,T>, VertexIdEdgeIterator<I,E>, VertexIdMessageBytesIterator<I,M>, VertexIdMessageIterator<I,M>

All Known Implementing Classes:

ByteStructVertexIdDataIterator, ByteStructVertexIdEdgeIterator, ByteStructVertexIdIterator, ByteStructVertexIdMessageBytesIterator, ByteStructVertexIdMessageIterator, OneMessageToManyIdsIterator

public interface VertexIdIterator<I extends org.apache.hadoop.io.WritableComparable>

Common implementation for VertexIdEdgeIterator, VertexIdMessageIterator and VertexIdMessageBytesIterator.

Method Summary

Modifier and Type	Method and Description
I	getCurrentVertexId() Get the current vertex id.
boolean	hasNext() Returns true if the iteration has more elements.
void	next() Moves to the next element in the iteration.
I	releaseCurrentVertexId() The backing store of the current vertex id is now released.

Method Detail

hasNext

boolean hasNext()

Returns true if the iteration has more elements.

Returns:

True if the iteration has more elements.

next

void next()

Moves to the next element in the iteration.

getCurrentVertexId

I getCurrentVertexId()

Get the current vertex id. Ihis object's contents are only guaranteed until next() is called. To take ownership of this object call releaseCurrentVertexId() after getting a reference to this object.

Returns:

Current vertex id

releaseCurrentVertexId

I releaseCurrentVertexId()

The backing store of the current vertex id is now released. Further calls to getCurrentVertexId () without calling next() will return null.

Returns:

Current vertex id that was released