@Immutable public interface ImmutableSet<T> extends ImmutableCollection<T>, UnsortedSetIterable<T>
MutableSet. MutableSet.toImmutable() will
give you an appropriately trimmed implementation of ImmutableSet. All ImmutableSet implementations must implement
the java.util.Set interface so they can satisfy the equals() contract and be compared against other set structures
like UnifiedSet or HashSet.| Modifier and Type | Method and Description |
|---|---|
Set<T> |
castToSet() |
<V> ImmutableSet<V> |
collect(Function<? super T,? extends V> function)
Returns a new collection with the results of applying the specified function on each element of the source
collection.
|
ImmutableBooleanSet |
collectBoolean(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. |
ImmutableByteSet |
collectByte(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. |
ImmutableCharSet |
collectChar(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. |
ImmutableDoubleSet |
collectDouble(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. |
ImmutableFloatSet |
collectFloat(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> ImmutableSet<V> |
collectIf(Predicate<? super T> predicate,
Function<? super T,? extends V> function)
Returns a new collection with the results of applying the specified function on each element of the source
collection, but only for those elements which return true upon evaluation of the predicate.
|
ImmutableIntSet |
collectInt(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. |
ImmutableLongSet |
collectLong(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. |
ImmutableShortSet |
collectShort(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> ImmutableSet<V> |
collectWith(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
|
ImmutableSet<T> |
difference(SetIterable<? extends T> subtrahendSet)
Returns the set of all members of
this that are not members of subtrahendSet. |
<V> ImmutableSet<V> |
flatCollect(Function<? super T,? extends Iterable<V>> function)
flatCollect is a special case of RichIterable.collect(Function). |
<V> ImmutableSetMultimap<V,T> |
groupBy(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> ImmutableSetMultimap<V,T> |
groupByEach(Function<? super T,? extends Iterable<V>> function)
Similar to
RichIterable.groupBy(Function), except the result of evaluating function will return a collection of keys
for each value. |
ImmutableSet<T> |
intersect(SetIterable<? extends T> set)
Returns the set of all objects that are members of both
this and set. |
ImmutableSet<T> |
newWith(T element) |
ImmutableSet<T> |
newWithAll(Iterable<? extends T> elements) |
ImmutableSet<T> |
newWithout(T element) |
ImmutableSet<T> |
newWithoutAll(Iterable<? extends T> elements) |
PartitionImmutableSet<T> |
partition(Predicate<? super T> predicate)
Filters a collection into a PartitionedIterable based on the evaluation of the predicate.
|
<P> PartitionImmutableSet<T> |
partitionWith(Predicate2<? super T,? super P> predicate,
P parameter)
Filters a collection into a PartitionIterable based on the evaluation of the predicate.
|
ImmutableSet<UnsortedSetIterable<T>> |
powerSet()
Returns the set whose members are all possible subsets of
this. |
ImmutableSet<T> |
reject(Predicate<? super T> predicate)
Returns all elements of the source collection that return false when evaluating of the predicate.
|
<P> ImmutableSet<T> |
rejectWith(Predicate2<? super T,? super P> predicate,
P parameter)
Similar to
RichIterable.reject(Predicate), except with an evaluation parameter for the second generic argument in Predicate2. |
ImmutableSet<T> |
select(Predicate<? super T> predicate)
Returns all elements of the source collection that return true when evaluating the predicate.
|
<S> ImmutableSet<S> |
selectInstancesOf(Class<S> clazz)
Returns all elements of the source collection that are instances of the Class
clazz. |
<P> ImmutableSet<T> |
selectWith(Predicate2<? super T,? super P> predicate,
P parameter)
Similar to
RichIterable.select(Predicate), except with an evaluation parameter for the second generic argument in Predicate2. |
ImmutableSet<T> |
symmetricDifference(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). |
ImmutableSet<T> |
union(SetIterable<? extends T> set)
Returns the set of all objects that are a member of
this or set or both. |
<S> ImmutableSet<Pair<T,S>> |
zip(Iterable<S> that)
Returns a
RichIterable formed from this RichIterable and another RichIterable by
combining corresponding elements in pairs. |
ImmutableSet<Pair<T,Integer>> |
zipWithIndex()
Zips this
RichIterable with its indices. |
aggregateBy, aggregateInPlaceBy, groupByUniqueKeytoImmutablecartesianProduct, differenceInto, equals, hashCode, intersectInto, isProperSubsetOf, isSubsetOf, symmetricDifferenceInto, unionIntoallSatisfy, 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, 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, toString, zip, zipWithIndexforEach, forEachWith, forEachWithIndexforEach, iterator, spliteratorImmutableSet<T> newWith(T element)
newWith in interface ImmutableCollection<T>ImmutableSet<T> newWithout(T element)
newWithout in interface ImmutableCollection<T>ImmutableSet<T> newWithAll(Iterable<? extends T> elements)
newWithAll in interface ImmutableCollection<T>ImmutableSet<T> newWithoutAll(Iterable<? extends T> elements)
newWithoutAll in interface ImmutableCollection<T>ImmutableSet<T> select(Predicate<? super T> predicate)
RichIterablee.g.
return people.select(new Predicate<Person>()
{
public boolean accept(Person person)
{
return person.getAddress().getCity().equals("Metuchen");
}
});
select in interface ImmutableCollection<T>select in interface RichIterable<T>select in interface SetIterable<T>select in interface UnsortedSetIterable<T><P> ImmutableSet<T> selectWith(Predicate2<? super T,? super P> predicate, P parameter)
RichIterableRichIterable.select(Predicate), except with an evaluation parameter for the second generic argument in Predicate2.selectWith in interface ImmutableCollection<T>selectWith in interface RichIterable<T>selectWith in interface SetIterable<T>selectWith in interface UnsortedSetIterable<T>predicate - a Predicate2 to use as the select criteriaparameter - a parameter to pass in for evaluation of the second argument P in predicateRichIterable.select(Predicate)ImmutableSet<T> reject(Predicate<? super T> predicate)
RichIterablee.g.
return people.reject(new Predicate<Person>()
{
public boolean accept(Person person)
{
return person.person.getLastName().equals("Smith");
}
});
e.g.
return people.reject(Predicates.attributeEqual("lastName", "Smith"));
reject in interface ImmutableCollection<T>reject in interface RichIterable<T>reject in interface SetIterable<T>reject in interface UnsortedSetIterable<T>predicate - a Predicate to use as the reject criteriaPredicate.accept(Object) method to evaluate to false<P> ImmutableSet<T> rejectWith(Predicate2<? super T,? super P> predicate, P parameter)
RichIterableRichIterable.reject(Predicate), except with an evaluation parameter for the second generic argument in Predicate2.rejectWith in interface ImmutableCollection<T>rejectWith in interface RichIterable<T>rejectWith in interface SetIterable<T>rejectWith in interface UnsortedSetIterable<T>predicate - a Predicate2 to use as the select criteriaparameter - a parameter to pass in for evaluation of the second argument P in predicateRichIterable.select(Predicate)PartitionImmutableSet<T> partition(Predicate<? super T> predicate)
RichIterablee.g.
return people.partition(new Predicate<Person>()
{
public boolean accept(Person person)
{
return person.getAddress().getState().getName().equals("New York");
}
});
partition in interface ImmutableCollection<T>partition in interface RichIterable<T>partition in interface SetIterable<T><P> PartitionImmutableSet<T> partitionWith(Predicate2<? super T,? super P> predicate, P parameter)
RichIterablee.g.
return people.partitionWith(new Predicate2<Person, String>()
{
public boolean accept(Person person, String state)
{
return person.getAddress().getState().getName().equals(state);
}
}, "New York");
partitionWith in interface ImmutableCollection<T>partitionWith in interface RichIterable<T>partitionWith in interface SetIterable<T><S> ImmutableSet<S> selectInstancesOf(Class<S> clazz)
RichIterableclazz.selectInstancesOf in interface ImmutableCollection<T>selectInstancesOf in interface RichIterable<T>selectInstancesOf in interface SetIterable<T>selectInstancesOf in interface UnsortedSetIterable<T><V> ImmutableSet<V> collect(Function<? super T,? extends V> function)
RichIterablee.g.
return people.collect(new Function<Person, String>()
{
public String valueOf(Person person)
{
return person.getFirstName() + " " + person.getLastName();
}
});
collect in interface ImmutableCollection<T>collect in interface RichIterable<T>collect in interface UnsortedSetIterable<T>ImmutableBooleanSet collectBoolean(BooleanFunction<? super T> booleanFunction)
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 ImmutableCollection<T>collectBoolean in interface RichIterable<T>collectBoolean in interface UnsortedSetIterable<T>ImmutableByteSet collectByte(ByteFunction<? super T> byteFunction)
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 ImmutableCollection<T>collectByte in interface RichIterable<T>collectByte in interface UnsortedSetIterable<T>ImmutableCharSet collectChar(CharFunction<? super T> charFunction)
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 ImmutableCollection<T>collectChar in interface RichIterable<T>collectChar in interface UnsortedSetIterable<T>ImmutableDoubleSet collectDouble(DoubleFunction<? super T> doubleFunction)
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 ImmutableCollection<T>collectDouble in interface RichIterable<T>collectDouble in interface UnsortedSetIterable<T>ImmutableFloatSet collectFloat(FloatFunction<? super T> floatFunction)
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 ImmutableCollection<T>collectFloat in interface RichIterable<T>collectFloat in interface UnsortedSetIterable<T>ImmutableIntSet collectInt(IntFunction<? super T> intFunction)
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 ImmutableCollection<T>collectInt in interface RichIterable<T>collectInt in interface UnsortedSetIterable<T>ImmutableLongSet collectLong(LongFunction<? super T> longFunction)
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 ImmutableCollection<T>collectLong in interface RichIterable<T>collectLong in interface UnsortedSetIterable<T>ImmutableShortSet collectShort(ShortFunction<? super T> shortFunction)
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 ImmutableCollection<T>collectShort in interface RichIterable<T>collectShort in interface UnsortedSetIterable<T><P,V> ImmutableSet<V> collectWith(Function2<? super T,? super P,? extends V> function, P parameter)
RichIterableFunction2 and specified parameter which is passed to the block