| net.sf.jga.fn.algorithm.FindMismatch
| FindMismatch | | public class FindMismatch extends LookAheadFunctor (Code) | | Locates the next element in an iteration that is not equal to the
corresponding element in a given collection.
To Serialize a FindMismatch, the generic parameter T must be serializable.
Copyright © 2003-2005 David A. Hall
author:
David A. Hall |
| Method Summary | |
| public void | accept(net.sf.jga.fn.Visitor v)
Calls the Visitor's visit(FindMismatch) method, if it
implements the nested Visitor interface. | | public LookAheadIterator<T> | fn(Iterator<? extends T> iterator)
Locates the first/next element in an iteration that is not the same as
the corresponding element in the given collection/iteration.
an iterator whose next() [if it hasNext()] points to the nextelement in the iteration that does not match the corresponding element inthe given collection. | | public BinaryFunctor<T, T, Boolean> | getComparisonFn()
| | public Collection<? extends T> | getElements()
Returns the collection against which the argument will be compared. | | public T | getMismatchedElement()
Returns the mismatched element in the given collection/iteration on the
last call to fn(). | | public String | toString()
|
| serialVersionUID | | final static long serialVersionUID(Code) | | |
| FindMismatch | | public FindMismatch(Collection<? extends T> elements)(Code) | | Builds a FindMismatch functor that uses !equals() to compare elements.
If the collection is null, an empty collection will be used for
comparison.
|
| FindMismatch | | public FindMismatch(Collection<? extends T> elements, BinaryFunctor<T, T, Boolean> neq)(Code) | | Builds a FindMismatch functor that uses the given functor to compare
elements. The functor is expected to compare two arguments and return
TRUE if they are not equal. If the collection is null, an empty
collection will be used for comparison.
|
| FindMismatch | | public FindMismatch(Iterator<? extends T> iter, BinaryFunctor<T, T, Boolean> neq)(Code) | | Builds one-time use FindMismatch finder that will test against the
contents of an iteration rather than a collection. The functor is
expected to compare two arguments and return TRUE if they are not
equal.
A FindMismatch built this way cannot be used more than once as the
contents of the iteration will be consumed in the first execution.
|
| accept | | public void accept(net.sf.jga.fn.Visitor v)(Code) | | Calls the Visitor's visit(FindMismatch) method, if it
implements the nested Visitor interface.
|
| fn | | public LookAheadIterator<T> fn(Iterator<? extends T> iterator)(Code) | | Locates the first/next element in an iteration that is not the same as
the corresponding element in the given collection/iteration.
an iterator whose next() [if it hasNext()] points to the nextelement in the iteration that does not match the corresponding element inthe given collection. If no such element exists and the iteration islonger than the the given collection, then the returned iterator's next()points to the first element that does not exist in the given collection.If no mismatched element exists and the collection is at least as long asthe iteration, then the returned iterator's hasNext() will be false. |
| getComparisonFn | | public BinaryFunctor<T, T, Boolean> getComparisonFn()(Code) | | Returns the functor that is used to test matching elements
|
| getElements | | public Collection<? extends T> getElements()(Code) | | Returns the collection against which the argument will be compared. When
called on a FindMismatch built with an iteration rather than a collection,
this method will return null
|
| getMismatchedElement | | public T getMismatchedElement()(Code) | | Returns the mismatched element in the given collection/iteration on the
last call to fn(). If the iterator passed to the last call to fn() had
no mismatch for the length of the collection, then this method returns
null.
throws:
IllegalStateException - if called before a call to fn. |
|
|