org.apache.giraph.utils

Interface VertexIdMessageIterator<I extends org.apache.hadoop.io.WritableComparable,M extends org.apache.hadoop.io.Writable>

Type Parameters:

I - vertexId type parameter

M - message type parameter

All Superinterfaces:

VertexIdDataIterator<I,M>, VertexIdIterator<I>

All Known Implementing Classes:

ByteStructVertexIdMessageIterator, OneMessageToManyIdsIterator

public interface VertexIdMessageIterator<I extends org.apache.hadoop.io.WritableComparable,M extends org.apache.hadoop.io.Writable>
extends VertexIdDataIterator<I,M>

Special iterator that reuses vertex ids and message objects so that the lifetime of the object is only until next() is called.

Method Summary

Modifier and Type	Method and Description
M	getCurrentMessage() Get the current message.
int	getCurrentMessageSize() Get the serialized size of current message
boolean	isNewMessage() Return true of current message is new

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

getCurrentData, getCurrentDataSize, releaseCurrentData

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

getCurrentVertexId, hasNext, next, releaseCurrentVertexId

Method Detail

getCurrentMessage

M getCurrentMessage()

Get the current message.

Returns:

Current message

getCurrentMessageSize

int getCurrentMessageSize()

Get the serialized size of current message

Returns:

serialized size of current message

isNewMessage

boolean isNewMessage()

Return true of current message is new

Returns:

true if current message is new