org.apache.giraph.utils

Interface VertexIdDataIterator<I extends org.apache.hadoop.io.WritableComparable,T>

Type Parameters:

I - vertexId type parameter

T - vertexData type parameter

All Superinterfaces:

VertexIdIterator<I>

All Known Subinterfaces:

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

All Known Implementing Classes:

ByteStructVertexIdDataIterator, ByteStructVertexIdEdgeIterator, ByteStructVertexIdMessageBytesIterator, ByteStructVertexIdMessageIterator, OneMessageToManyIdsIterator

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

Special iterator that reuses vertex ids and data objects so that the lifetime of the object is only until next() is called. Vertex id ownership can be released if desired through releaseCurrentVertexId(). This optimization allows us to cut down on the number of objects instantiated and garbage collected.

Method Summary

Modifier and Type	Method and Description
T	getCurrentData() Get the current data.
int	getCurrentDataSize() Get serialized size of current data
T	releaseCurrentData() Release the current data object.

Methods inherited from interface org.apache.giraph.utils.VertexIdIterator

getCurrentVertexId, hasNext, next, releaseCurrentVertexId

Method Detail

getCurrentData

T getCurrentData()

Get the current data.

Returns:

Current data

getCurrentDataSize

int getCurrentDataSize()

Get serialized size of current data

Returns:

serialized size of data

releaseCurrentData

T releaseCurrentData()

Release the current data object.

Returns:

Released data object