@ThreadSafe public class SynchronizedMutableSet<T> extends AbstractSynchronizedMutableCollection<T> implements com.gs.collections.api.set.MutableSet<T>, java.io.Serializable
MutableSet. It is imperative that the user manually synchronize on the collection when iterating over it using the
standard JDK iterator or JDK 5 for loop, as per Collections.synchronizedCollection(Collection).MutableSet.asSynchronized(),
Serialized Form| Modifier and Type | Method and Description |
|---|---|
com.gs.collections.api.set.MutableSet<T> |
asSynchronized()
Returns a synchronized (thread-safe) collection backed by this collection.
|
com.gs.collections.api.set.MutableSet<T> |
asUnmodifiable()
Returns an unmodifiable view of this collection.
|
<B> com.gs.collections.api.LazyIterable<com.gs.collections.api.tuple.Pair<T,B>> |
cartesianProduct(com.gs.collections.api.set.SetIterable<B> set)
Returns the set whose members are all possible ordered pairs (a, b) where a is a member of
this and b is a
member of set. |
com.gs.collections.api.set.MutableSet<T> |
clone() |
<V> com.gs.collections.api.set.MutableSet<V> |
collect(com.gs.collections.api.block.function.Function<? super T,? extends V> function)
Returns a new MutableCollection with the results of applying the specified function to each element of the source
collection.
|
com.gs.collections.api.set.primitive.MutableBooleanSet |
collectBoolean(com.gs.collections.api.block.function.primitive.BooleanFunction<? super T> booleanFunction)
Returns a new primitive
boolean iterable with the results of applying the specified function on each element
of the source collection. |
com.gs.collections.api.set.primitive.MutableByteSet |
collectByte(com.gs.collections.api.block.function.primitive.ByteFunction<? super T> byteFunction)
Returns a new primitive
byte iterable with the results of applying the specified function on each element
of the source collection. |
com.gs.collections.api.set.primitive.MutableCharSet |
collectChar(com.gs.collections.api.block.function.primitive.CharFunction<? super T> charFunction)
Returns a new primitive
char iterable with the results of applying the specified function on each element
of the source collection. |
com.gs.collections.api.set.primitive.MutableDoubleSet |
collectDouble(com.gs.collections.api.block.function.primitive.DoubleFunction<? super T> doubleFunction)
Returns a new primitive
double iterable with the results of applying the specified function on each element
of the source collection. |
com.gs.collections.api.set.primitive.MutableFloatSet |
collectFloat(com.gs.collections.api.block.function.primitive.FloatFunction<? super T> floatFunction)
Returns a new primitive
float iterable with the results of applying the specified function on each element
of the source collection. |
<V> com.gs.collections.api.set.MutableSet<V> |
collectIf(com.gs.collections.api.block.predicate.Predicate<? super T> predicate,
com.gs.collections.api.block.function.Function<? super T,? extends V> function)
Returns a new MutableCollection with the results of applying the specified function to each element of the source
collection, but only for elements that evaluate to true for the specified predicate.
|
com.gs.collections.api.set.primitive.MutableIntSet |
collectInt(com.gs.collections.api.block.function.primitive.IntFunction<? super T> intFunction)
Returns a new primitive
int iterable with the results of applying the specified function on each element
of the source collection. |
com.gs.collections.api.set.primitive.MutableLongSet |
collectLong(com.gs.collections.api.block.function.primitive.LongFunction<? super T> longFunction)
Returns a new primitive
long iterable with the results of applying the specified function on each element
of the source collection. |
com.gs.collections.api.set.primitive.MutableShortSet |
collectShort(com.gs.collections.api.block.function.primitive.ShortFunction<? super T> shortFunction)
Returns a new primitive
short iterable with the results of applying the specified function on each element
of the source collection. |
<P,V> com.gs.collections.api.set.MutableSet<V> |
collectWith(com.gs.collections.api.block.function.Function2<? super T,? super P,? extends V> function,
P parameter)
Same as collect with a
Function2 and specified parameter which is passed to the block
|
com.gs.collections.api.set.MutableSet<T> |
difference(com.gs.collections.api.set.SetIterable<? extends T> subtrahendSet)
Returns the set of all members of
this that are not members of subtrahendSet. |
<R extends java.util.Set<T>> |
differenceInto(com.gs.collections.api.set.SetIterable<? extends T> subtrahendSet,
R targetSet)
Same as
SetIterable.difference(SetIterable) but adds all the objects to targetSet and returns it. |
boolean |
equals(java.lang.Object obj)
Follows the same general contract as
Set.equals(Object). |
<V> com.gs.collections.api.set.MutableSet<V> |
flatCollect(com.gs.collections.api.block.function.Function<? super T,? extends java.lang.Iterable<V>> function)
flatCollect is a special case of RichIterable.collect(Function). |
<V> com.gs.collections.api.multimap.set.MutableSetMultimap<V,T> |
groupBy(com.gs.collections.api.block.function.Function<? super T,? extends V> function)
For each element of the iterable, the function is evaluated and the results of these evaluations are collected
into a new multimap, where the transformed value is the key and the original values are added to the same (or similar)
species of collection as the source iterable.
|
<V> com.gs.collections.api.multimap.set.MutableSetMultimap<V,T> |
groupByEach(com.gs.collections.api.block.function.Function<? super T,? extends java.lang.Iterable<V>> function)
Similar to
RichIterable.groupBy(Function), except the result of evaluating function will return a collection of keys
for each value. |
int |
hashCode()
Follows the same general contract as
Set.hashCode(). |
com.gs.collections.api.set.MutableSet<T> |
intersect(com.gs.collections.api.set.SetIterable<? extends T> set)
Returns the set of all objects that are members of both
this and set. |
<R extends java.util.Set<T>> |
intersectInto(com.gs.collections.api.set.SetIterable<? extends T> set,
R targetSet)
Same as
SetIterable.intersect(SetIterable) but adds all the objects to targetSet and returns it. |
boolean |
isProperSubsetOf(com.gs.collections.api.set.SetIterable<? extends T> candidateSuperset)
Returns true if all the members of
this are also members of candidateSuperset and the
two sets are not equal. |
boolean |
isSubsetOf(com.gs.collections.api.set.SetIterable<? extends T> candidateSuperset)
Returns true if all the members of
this are also members of candidateSuperset. |
com.gs.collections.api.set.MutableSet<T> |
newEmpty()
Creates a new empty mutable version of the same collection type.
|
static <E,S extends java.util.Set<E>> |
of(S set)
This method will take a MutableSet and wrap it directly in a SynchronizedMutableSet.
|
static <E,S extends java.util.Set<E>> |
of(S set,
java.lang.Object lock)
This method will take a MutableSet and wrap it directly in a SynchronizedMutableSet.
|
com.gs.collections.api.partition.set.PartitionMutableSet<T> |
partition(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)
Filters a collection into a PartitionedIterable based on the evaluation of the predicate.
|
<P> com.gs.collections.api.partition.set.PartitionMutableSet<T> |
partitionWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate,
P parameter)
Filters a collection into a PartitionIterable based on the evaluation of the predicate.
|
com.gs.collections.api.set.MutableSet<com.gs.collections.api.set.UnsortedSetIterable<T>> |
powerSet()
Returns the set whose members are all possible subsets of
this. |
com.gs.collections.api.set.MutableSet<T> |
reject(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)
Returns a MutableCollection with all elements that evaluate to false for the specified predicate.
|
<P> com.gs.collections.api.set.MutableSet<T> |
rejectWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate,
P parameter)
Returns a MutableCollection with all elements that evaluate to false for the specified predicate2 and parameter.
|
com.gs.collections.api.set.MutableSet<T> |
select(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)
Returns a MutableCollection with all elements that evaluate to true for the specified predicate.
|
<S> com.gs.collections.api.set.MutableSet<S> |
selectInstancesOf(java.lang.Class<S> clazz)
Returns all elements of the source collection that are instances of the Class
clazz. |
<P> com.gs.collections.api.set.MutableSet<T> |
selectWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate,
P parameter)
Returns a MutableCollection with all elements that evaluate to true for the specified predicate2 and parameter.
|
com.gs.collections.api.set.MutableSet<T> |
symmetricDifference(com.gs.collections.api.set.SetIterable<? extends T> setB)
Returns the set of all objects that are a member of exactly one of
this and setB (elements which
are in one of the sets, but not in both). |
<R extends java.util.Set<T>> |
symmetricDifferenceInto(com.gs.collections.api.set.SetIterable<? extends T> set,
R targetSet)
Same as
SetIterable.symmetricDifference(SetIterable) but adds all the objects to targetSet and returns it. |
com.gs.collections.api.set.ImmutableSet<T> |
toImmutable()
Converts this MutableCollection to an ImmutableCollection.
|
com.gs.collections.api.set.MutableSet<T> |
union(com.gs.collections.api.set.SetIterable<? extends T> set)
Returns the set of all objects that are a member of
this or set or both. |
<R extends java.util.Set<T>> |
unionInto(com.gs.collections.api.set.SetIterable<? extends T> set,
R targetSet)
Same as
SetIterable.union(SetIterable) but adds all the objects to targetSet and returns it. |
com.gs.collections.api.set.MutableSet<T> |
with(T element)
This method allows mutable and fixed size collections the ability to add elements to their existing elements.
|
com.gs.collections.api.set.MutableSet<T> |
withAll(java.lang.Iterable<? extends T> elements)
This method allows mutable and fixed size collections the ability to add multiple elements to their existing
elements.
|
com.gs.collections.api.set.MutableSet<T> |
without(T element)
This method allows mutable and fixed size collections the ability to remove elements from their existing elements.
|
com.gs.collections.api.set.MutableSet<T> |
withoutAll(java.lang.Iterable<? extends T> elements)
This method allows mutable and fixed size collections the ability to remove multiple elements from their existing
elements.
|
protected java.lang.Object |
writeReplace() |
<S> com.gs.collections.api.set.MutableSet<com.gs.collections.api.tuple.Pair<T,S>> |
zip(java.lang.Iterable<S> that)
Returns a
RichIterable formed from this RichIterable and another RichIterable by
combining corresponding elements in pairs. |
<S,R extends java.util.Collection<com.gs.collections.api.tuple.Pair<T,S>>> |
zip(java.lang.Iterable<S> that,
R target)
Same as
RichIterable.zip(Iterable) but uses target for output. |
com.gs.collections.api.set.MutableSet<com.gs.collections.api.tuple.Pair<T,java.lang.Integer>> |
zipWithIndex()
Zips this
RichIterable with its indices. |
<R extends java.util.Collection<com.gs.collections.api.tuple.Pair<T,java.lang.Integer>>> |
zipWithIndex(R target)
Same as
RichIterable.zipWithIndex() but uses target for output. |
add, addAll, addAllIterable, aggregateBy, aggregateInPlaceBy, allSatisfy, allSatisfyWith, anySatisfy, anySatisfyWith, appendString, appendString, appendString, asLazy, chunk, clear, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, contains, containsAll, containsAllArguments, containsAllIterable, count, countWith, detect, detectIfNone, detectWith, detectWithIfNone, flatCollect, forEach, forEachWith, forEachWithIndex, getCollection, getFirst, getLast, getLock, groupBy, groupByEach, groupByUniqueKey, injectInto, injectInto, injectInto, injectInto, injectInto, injectIntoWith, isEmpty, iterator, makeString, makeString, makeString, max, max, maxBy, min, min, minBy, noneSatisfy, noneSatisfyWith, notEmpty, reject, rejectWith, remove, removeAll, removeAllIterable, removeIf, removeIfWith, retainAll, retainAllIterable, select, selectAndRejectWith, selectWith, size, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toArray, toArray, toBag, toList, toMap, toSet, toSortedList, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedSet, toSortedSet, toSortedSetBy, toStringfinalize, getClass, notify, notifyAll, wait, wait, waitaggregateBy, aggregateInPlaceBy, allSatisfy, allSatisfyWith, anySatisfy, anySatisfyWith, appendString, appendString, appendString, asLazy, chunk, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, contains, containsAll, containsAllArguments, containsAllIterable, count, countWith, detect, detectIfNone, detectWith, detectWithIfNone, flatCollect, getFirst, getLast, groupBy, groupByEach, groupByUniqueKey, injectInto, injectInto, injectInto, injectInto, injectInto, isEmpty, makeString, makeString, makeString, max, max, maxBy, min, min, minBy, noneSatisfy, noneSatisfyWith, notEmpty, reject, rejectWith, select, selectWith, size, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toArray, toArray, toBag, toList, toMap, toSet, toSortedList, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedSet, toSortedSet, toSortedSetBy, toStringforEach, forEachWith, forEachWithIndexpublic static <E,S extends java.util.Set<E>> SynchronizedMutableSet<E> of(S set)
public static <E,S extends java.util.Set<E>> SynchronizedMutableSet<E> of(S set, java.lang.Object lock)
public com.gs.collections.api.set.MutableSet<T> asUnmodifiable()
com.gs.collections.api.collection.MutableCollectionThe returned collection will be serializable if this collection is serializable.
asUnmodifiable in interface com.gs.collections.api.collection.MutableCollection<T>asUnmodifiable in interface com.gs.collections.api.set.MutableSet<T>asUnmodifiable in class AbstractSynchronizedMutableCollection<T>public com.gs.collections.api.set.ImmutableSet<T> toImmutable()
com.gs.collections.api.collection.MutableCollectiontoImmutable in interface com.gs.collections.api.collection.MutableCollection<T>toImmutable in interface com.gs.collections.api.set.MutableSet<T>toImmutable in interface com.gs.collections.api.set.UnsortedSetIterable<T>toImmutable in class AbstractSynchronizedMutableCollection<T>public com.gs.collections.api.set.MutableSet<T> asSynchronized()
com.gs.collections.api.collection.MutableCollection
MutableCollection collection = myCollection.asSynchronized();
...
synchronized(collection)
{
Iterator i = c.iterator(); // Must be in the synchronized block
while (i.hasNext())
foo(i.next());
}
Failure to follow this advice may result in non-deterministic behavior.
The preferred way of iterating over a synchronized collection is to use the collection.forEach() method which is
properly synchronized internally.
MutableCollection collection = myCollection.asSynchronized();
...
collection.forEach(new Procedure()
{
public void value(Object each)
{
...
}
});
The returned collection does not pass the hashCode and equals operations through to the
backing collection, but relies on Object's equals and hashCode methods. This is necessary to preserve
the contracts of these operations in the case that the backing collection is a set or a list.
The returned collection will be serializable if this collection is serializable.asSynchronized in interface com.gs.collections.api.collection.MutableCollection<T>asSynchronized in interface com.gs.collections.api.set.MutableSet<T>asSynchronized in class AbstractSynchronizedMutableCollection<T>public com.gs.collections.api.set.MutableSet<T> clone()
clone in interface com.gs.collections.api.set.MutableSet<T>clone in class java.lang.Objectpublic <V> com.gs.collections.api.set.MutableSet<V> collect(com.gs.collections.api.block.function.Function<? super T,? extends V> function)
com.gs.collections.api.collection.MutableCollectione.g.
return people.collect(new Function<Person, String>()
{
public String value(Person person)
{
return person.getFirstName() + " " + person.getLastName();
}
});
collect in interface com.gs.collections.api.collection.MutableCollection<T>collect in interface com.gs.collections.api.RichIterable<T>collect in interface com.gs.collections.api.set.MutableSet<T>collect in interface com.gs.collections.api.set.UnsortedSetIterable<T>collect in class AbstractSynchronizedMutableCollection<T>public com.gs.collections.api.set.primitive.MutableBooleanSet collectBoolean(com.gs.collections.api.block.function.primitive.BooleanFunction<? super T> booleanFunction)
com.gs.collections.api.RichIterableboolean iterable with the results of applying the specified function on each element
of the source collection. This method is also commonly called transform or map.
e.g.
return people.collectBoolean(new BooleanFunction<Person>()
{
public boolean booleanValueOf(Person person)
{
return person.hasDrivingLicense();
}
});
collectBoolean in interface com.gs.collections.api.collection.MutableCollection<T>collectBoolean in interface com.gs.collections.api.RichIterable<T>collectBoolean in interface com.gs.collections.api.set.MutableSet<T>collectBoolean in interface com.gs.collections.api.set.UnsortedSetIterable<T>collectBoolean in class AbstractSynchronizedMutableCollection<T>public com.gs.collections.api.set.primitive.MutableByteSet collectByte(com.gs.collections.api.block.function.primitive.ByteFunction<? super T> byteFunction)
com.gs.collections.api.RichIterablebyte iterable with the results of applying the specified function on each element
of the source collection. This method is also commonly called transform or map.
e.g.
return people.collectByte(new ByteFunction<Person>()
{
public byte byteValueOf(Person person)
{
return person.getCode();
}
});
collectByte in interface com.gs.collections.api.collection.MutableCollection<T>collectByte in interface com.gs.collections.api.RichIterable<T>collectByte in interface com.gs.collections.api.set.MutableSet<T>collectByte in interface com.gs.collections.api.set.UnsortedSetIterable<T>collectByte in class AbstractSynchronizedMutableCollection<T>public com.gs.collections.api.set.primitive.MutableCharSet collectChar(com.gs.collections.api.block.function.primitive.CharFunction<? super T> charFunction)
com.gs.collections.api.RichIterablechar iterable with the results of applying the specified function on each element
of the source collection. This method is also commonly called transform or map.
e.g.
return people.collectChar(new CharFunction<Person>()
{
public char charValueOf(Person person)
{
return person.getMiddleInitial();
}
});
collectChar in interface com.gs.collections.api.collection.MutableCollection<T>collectChar in interface com.gs.collections.api.RichIterable<T>collectChar in interface com.gs.collections.api.set.MutableSet<T>collectChar in interface com.gs.collections.api.set.UnsortedSetIterable<T>collectChar in class AbstractSynchronizedMutableCollection<T>public com.gs.collections.api.set.primitive.MutableDoubleSet collectDouble(com.gs.collections.api.block.function.primitive.DoubleFunction<? super T> doubleFunction)
com.gs.collections.api.RichIterabledouble iterable with the results of applying the specified function on each element
of the source collection. This method is also commonly called transform or map.
e.g.
return people.collectDouble(new DoubleFunction<Person>()
{
public double doubleValueOf(Person person)
{
return person.getMilesFromNorthPole();
}
});
collectDouble in interface com.gs.collections.api.collection.MutableCollection<T>collectDouble in interface com.gs.collections.api.RichIterable<T>collectDouble in interface com.gs.collections.api.set.MutableSet<T>collectDouble in interface com.gs.collections.api.set.UnsortedSetIterable<T>collectDouble in class AbstractSynchronizedMutableCollection<T>public com.gs.collections.api.set.primitive.MutableFloatSet collectFloat(com.gs.collections.api.block.function.primitive.FloatFunction<? super T> floatFunction)
com.gs.collections.api.RichIterablefloat iterable with the results of applying the specified function on each element
of the source collection. This method is also commonly called transform or map.
e.g.
return people.collectFloat(new FloatFunction<Person>()
{
public float floatValueOf(Person person)
{
return person.getHeightInInches();
}
});
collectFloat in interface com.gs.collections.api.collection.MutableCollection<T>collectFloat in interface com.gs.collections.api.RichIterable<T>collectFloat in interface com.gs.collections.api.set.MutableSet<T>collectFloat in interface com.gs.collections.api.set.UnsortedSetIterable<T>collectFloat in class AbstractSynchronizedMutableCollection<T>public com.gs.collections.api.set.primitive.MutableIntSet collectInt(com.gs.collections.api.block.function.primitive.IntFunction<? super T> intFunction)
com.gs.collections.api.RichIterableint iterable with the results of applying the specified function on each element
of the source collection. This method is also commonly called transform or map.
e.g.
return people.collectInt(new IntFunction<Person>()
{
public int intValueOf(Person person)
{
return person.getAge();
}
});
collectInt in interface com.gs.collections.api.collection.MutableCollection<T>collectInt in interface com.gs.collections.api.RichIterable<T>collectInt in interface com.gs.collections.api.set.MutableSet<T>collectInt in interface com.gs.collections.api.set.UnsortedSetIterable<T>collectInt in class AbstractSynchronizedMutableCollection<T>public com.gs.collections.api.set.primitive.MutableLongSet collectLong(com.gs.collections.api.block.function.primitive.LongFunction<? super T> longFunction)
com.gs.collections.api.RichIterablelong iterable with the results of applying the specified function on each element
of the source collection. This method is also commonly called transform or map.
e.g.
return people.collectLong(new LongFunction<Person>()
{
public long longValueOf(Person person)
{
return person.getGuid();
}
});
collectLong in interface com.gs.collections.api.collection.MutableCollection<T>collectLong in interface com.gs.collections.api.RichIterable<T>collectLong in interface com.gs.collections.api.set.MutableSet<T>collectLong in interface com.gs.collections.api.set.UnsortedSetIterable<T>collectLong in class AbstractSynchronizedMutableCollection<T>public com.gs.collections.api.set.primitive.MutableShortSet collectShort(com.gs.collections.api.block.function.primitive.ShortFunction<? super T> shortFunction)
com.gs.collections.api.RichIterableshort iterable with the results of applying the specified function on each element
of the source collection. This method is also commonly called transform or map.
e.g.
return people.collectShort(new ShortFunction<Person>()
{
public short shortValueOf(Person person)
{
return person.getNumberOfJunkMailItemsReceivedPerMonth();
}
});
collectShort in interface com.gs.collections.api.collection.MutableCollection<T>collectShort in interface com.gs.collections.api.RichIterable<T>collectShort in interface com.gs.collections.api.set.MutableSet<T>collectShort in interface com.gs.collections.api.set.UnsortedSetIterable<T>collectShort in class AbstractSynchronizedMutableCollection<T>public <V> com.gs.collections.api.set.MutableSet<V> flatCollect(com.gs.collections.api.block.function.Function<? super T,? extends java.lang.Iterable<V>> function)
com.gs.collections.api.RichIterableflatCollect is a special case of RichIterable.collect(Function). With collect, when the Function returns
a collection, the result is a collection of collections. flatCollect outputs a single "flattened" collection
instead. This method is commonly called flatMap.
Consider the following example where we have a Person class, and each Person has a list of Address objects. Take the following Function:
Function<Person, List<Address>> addressFunction = new Function<Person, List<Address>>() {
public List<Address> valueOf(Person person) {
return person.getAddresses();
}
};
MutableList<Person> people = ...;
Using collect returns a collection of collections of addresses.
MutableList<List<Address>> addresses = people.collect(addressFunction);Using
flatCollect returns a single flattened list of addresses.
MutableList<Address> addresses = people.flatCollect(addressFunction);
flatCollect in interface com.gs.collections.api.collection.MutableCollection<T>flatCollect in interface com.gs.collections.api.RichIterable<T>flatCollect in interface com.gs.collections.api.set.MutableSet<T>flatCollect in interface com.gs.collections.api.set.UnsortedSetIterable<T>flatCollect in class AbstractSynchronizedMutableCollection<T>function - The Function to applyfunctionpublic <V> com.gs.collections.api.set.MutableSet<V> collectIf(com.gs.collections.api.block.predicate.Predicate<? super T> predicate, com.gs.collections.api.block.function.Function<? super T,? extends V> function)
com.gs.collections.api.collection.MutableCollectione.g. Lists.mutable.of().with(1, 2, 3).collectIf(Predicates.notNull(), Functions.getToString())
collectIf in interface com.gs.collections.api.collection.MutableCollection<T>collectIf in interface com.gs.collections.api.RichIterable<T>collectIf in interface com.gs.collections.api.set.MutableSet<T>collectIf in interface com.gs.collections.api.set.UnsortedSetIterable<T>collectIf in class AbstractSynchronizedMutableCollection<T>public <P,V> com.gs.collections.api.set.MutableSet<V> collectWith(com.gs.collections.api.block.function.Function2<? super T,? super P,? extends V> function, P parameter)
com.gs.collections.api.RichIterableFunction2 and specified parameter which is passed to the block