Class FilteredCollection<A>

java.lang.Object

microsim.FilteredCollection<A>

All Implemented Interfaces:

Supplier<List<A>>

public class FilteredCollection<A>
extends Object
implements Supplier<List<A>>

Lazy collection filtering.

This lazily applies a Predicate as filter to a collection, acting as a Supplier for the filtered collection. This composes well with caching mechanisms offered in microsim.caching.

Constructor Summary

Constructors

Constructor	Description
FilteredCollection(Supplier<? extends Collection<? extends A>> source, Predicate<? super A> predicate)	Create a lazy filtered collection.

Method Summary

Modifier and Type	Method	Description
FilteredCollection<A>	and(Predicate<? super A> predicate)	Create a new filtered collection derived from this one by and-ing both predicates.
List<A>	get()	Apply the filtering.
FilteredCollection<A>	negate()	Create a new filtered collection derived from this one by negating the predicate.
Once<List<A>>	once()	Wrap the FilteredCollection in a Once cache.
OnceUntil<List<A>>	oncePerSimTime(SimulationEngine engine)	Wrap the FilteredCollection in a OnceUntil cache that checks when the simulation time changes.
FilteredCollection<A>	or(Predicate<? super A> predicate)	Create a new filtered collection derived from this one by or-ing both predicates.

Methods inherited from class Object

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

Constructor Details

FilteredCollection

public FilteredCollection(Supplier<? extends Collection<? extends A>> source,
 Predicate<? super A> predicate)

Create a lazy filtered collection.

Method Details

and

public FilteredCollection<A> and(Predicate<? super A> predicate)

Create a new filtered collection derived from this one by and-ing both predicates.

or

public FilteredCollection<A> or(Predicate<? super A> predicate)

Create a new filtered collection derived from this one by or-ing both predicates.

negate

public FilteredCollection<A> negate()

Create a new filtered collection derived from this one by negating the predicate.

get

public List<A> get()

Apply the filtering.

Specified by:

get in interface Supplier<A>

once

public Once<List<A>> once()

Wrap the FilteredCollection in a Once cache.

oncePerSimTime

public OnceUntil<List<A>> oncePerSimTime(SimulationEngine engine)

Wrap the FilteredCollection in a OnceUntil cache that checks when the simulation time changes.