com.tinkerpop.pipes.sideeffect

Class CountPipe<S>

java.lang.Object

com.tinkerpop.pipes.AbstractPipe<S,S>

com.tinkerpop.pipes.sideeffect.CountPipe<S>

All Implemented Interfaces:

Pipe<S,S>, SideEffectPipe<S,Long>, SideEffectPipe.GreedySideEffectPipe<S,Long>, Iterable<S>, Iterator<S>

public class CountPipe<S>
extends AbstractPipe<S,S>
implements SideEffectPipe.GreedySideEffectPipe<S,Long>

The CountPipe produces a side effect that is the total number of objects that have passed through it.

Author:

Marko A. Rodriguez (http://markorodriguez.com)

Nested Class Summary

Nested classes/interfaces inherited from interface com.tinkerpop.pipes.sideeffect.SideEffectPipe

SideEffectPipe.GreedySideEffectPipe<S,T>, SideEffectPipe.LazySideEffectPipe<S,T>

Field Summary

Fields inherited from class com.tinkerpop.pipes.AbstractPipe

currentEnd, pathEnabled, starts

Fields inherited from interface com.tinkerpop.pipes.Pipe

NO_PATH_MESSAGE

Constructor Summary

Constructors

Constructor and Description
CountPipe()

Method Summary

Methods

Modifier and Type	Method and Description
Long	getSideEffect()
protected S	processNextStart()
void	reset() A pipe may maintain state.

Methods inherited from class com.tinkerpop.pipes.AbstractPipe

enablePath, getCurrentPath, getPathToHere, hasNext, iterator, next, remove, setStarts, setStarts, setStarts, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.tinkerpop.pipes.Pipe

enablePath, getCurrentPath, setStarts, setStarts

Methods inherited from interface java.util.Iterator

hasNext, next, remove

Methods inherited from interface java.lang.Iterable

iterator

Constructor Detail

CountPipe

public CountPipe()

Method Detail

processNextStart

protected S processNextStart()

Specified by:

processNextStart in class AbstractPipe<S,S>

getSideEffect

public Long getSideEffect()

Specified by:

getSideEffect in interface SideEffectPipe<S,Long>

reset

public void reset()

Description copied from interface: Pipe

A pipe may maintain state. Reset is used to remove state. The general use case for reset() is to reuse a pipe in another computation without having to create a new Pipe object. An implementation of this method should be recursive whereby the starts (if a Pipe) should have this method called on it.

Specified by:

reset in interface Pipe<S,S>

Overrides:

reset in class AbstractPipe<S,S>