org.apache.giraph.block_app.framework.block

Class RepeatUntilBlock

java.lang.Object

org.apache.giraph.block_app.framework.block.RepeatUntilBlock

All Implemented Interfaces:

Iterable<AbstractPiece>, Block

public final class RepeatUntilBlock
extends Object
implements Block

Block that repeats another block until toQuit supplier returns true, but at most given number of times. If toQuit returns true on first run, block is not going to be executed at all.

Constructor Summary

Constructors

Constructor and Description
RepeatUntilBlock(int repeatTimes, Block block, Supplier<Boolean> toQuit)

Method Summary

Modifier and Type	Method and Description
void	forAllPossiblePieces(Consumer<AbstractPiece> consumer) Calls consumer for each Piece: - in no particular order - potentially calling multiple times on same Piece - even if Piece might never be returned in the iterator - it will be called at least once for every piece that is going to be returned by iterator Can be used for static analysis/introspection of the block, without actually executing them.
PieceCount	getPieceCount() How many pieces are in this block.
Iterator<AbstractPiece>	iterator() Create iterator representing all pieces needed to be executed in this block.
String	toString()
static Block	unlimited(Block block, Supplier<Boolean> toQuit) Repeat unlimited number of times, until toQuit supplier returns true.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

RepeatUntilBlock

public RepeatUntilBlock(int repeatTimes,
                        Block block,
                        Supplier<Boolean> toQuit)

Method Detail

unlimited

public static Block unlimited(Block block,
                              Supplier<Boolean> toQuit)

Repeat unlimited number of times, until toQuit supplier returns true.

iterator

public Iterator<AbstractPiece> iterator()

Description copied from interface: Block

Create iterator representing all pieces needed to be executed in this block. After Iterator.next call returns, master compute of returned Piece is guaranteed to be called before calling hasNext/next on the iterator. (allows for iterators logic to depend on the execution dynamically, and not be only static)

Specified by:

iterator in interface Iterable<AbstractPiece>

Specified by:

iterator in interface Block

forAllPossiblePieces

public void forAllPossiblePieces(Consumer<AbstractPiece> consumer)

Description copied from interface: Block

Calls consumer for each Piece: - in no particular order - potentially calling multiple times on same Piece - even if Piece might never be returned in the iterator - it will be called at least once for every piece that is going to be returned by iterator Can be used for static analysis/introspection of the block, without actually executing them.

Specified by:

forAllPossiblePieces in interface Block

getPieceCount

public PieceCount getPieceCount()

Description copied from interface: Block

How many pieces are in this block. Sometimes we don't know (eg RepeatBlock).

Specified by:

getPieceCount in interface Block

Returns:

How many pieces are in this block.

toString

public String toString()

Overrides:

toString in class Object