com.tinkerpop.pipes.transform

Class HasCountPipe<S>

java.lang.Object

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

com.tinkerpop.pipes.transform.HasCountPipe<S>

All Implemented Interfaces:

Pipe<S,Boolean>, TransformPipe<S,Boolean>, Iterable<Boolean>, Iterator<Boolean>

public class HasCountPipe<S>
extends AbstractPipe<S,Boolean>
implements TransformPipe<S,Boolean>

Author:

Darrick Wiebe (http://ofallpossibleworlds.wordpress.com)

Nested Class Summary

Nested classes/interfaces inherited from interface com.tinkerpop.pipes.transform.TransformPipe

TransformPipe.Order

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
HasCountPipe(long min, long max) The pipe must emit at least min and not more than max elements.

Method Summary

Methods

Modifier and Type	Method and Description
Boolean	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

HasCountPipe

public HasCountPipe(long min,
            long max)

The pipe must emit at least min and not more than max elements.

Parameters:

min - minimum number of elements. Use -1 for no minimum.

max - maximum number of elements. Use -1 for no maximum.

Method Detail

processNextStart

public Boolean processNextStart()

Specified by:

processNextStart in class AbstractPipe<S,Boolean>

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,Boolean>

Overrides:

reset in class AbstractPipe<S,Boolean>