T - Component typepublic final class TreeSet<T> extends java.lang.Object implements SortedSet<T>, java.io.Serializable
| Modifier and Type | Method and Description |
|---|---|
TreeSet<T> |
add(T element)
Add the given element to this set, if it is not already contained.
|
TreeSet<T> |
addAll(java.lang.Iterable<? extends T> elements)
Adds all of the given elements to this set, if not already contained.
|
<R> TreeSet<R> |
collect(PartialFunction<? super T,? extends R> partialFunction)
Collects all elements that are in the domain of the given
partialFunction by mapping the elements to type R. |
static <T extends java.lang.Comparable<? super T>> |
collector()
Returns a
Collector which may be used in conjunction with
Stream.collect(java.util.stream.Collector) to obtain a TreeSet. |
static <T> java.util.stream.Collector<T,java.util.ArrayList<T>,TreeSet<T>> |
collector(java.util.Comparator<? super T> comparator)
Returns a
Collector which may be used in conjunction with
Stream.collect(java.util.stream.Collector) to obtain a TreeSet. |
java.util.Comparator<T> |
comparator()
Returns the comparator which defines the order of the elements contained in this collection.
|
boolean |
contains(T element)
Shortcut for
exists(e -> Objects.equals(e, element)), tests if the given element is contained. |
TreeSet<T> |
diff(Set<? extends T> elements)
Calculates the difference between this set and another set.
|
TreeSet<T> |
distinct()
Returns a new version of this which contains no duplicates.
|
TreeSet<T> |
distinctBy(java.util.Comparator<? super T> comparator)
Returns a new version of this which contains no duplicates.
|
<U> TreeSet<T> |
distinctBy(java.util.function.Function<? super T,? extends U> keyExtractor)
Returns a new version of this which contains no duplicates.
|
TreeSet<T> |
drop(int n)
Drops the first n elements of this or all elements, if this length < n.
|
TreeSet<T> |
dropRight(int n)
Drops the last n elements of this or all elements, if this length < n.
|
TreeSet<T> |
dropUntil(java.util.function.Predicate<? super T> predicate)
Drops elements until the predicate holds for the current element.
|
TreeSet<T> |
dropWhile(java.util.function.Predicate<? super T> predicate)
Drops elements while the predicate holds for the current element.
|
static <T extends java.lang.Comparable<? super T>> |
empty() |
static <T> TreeSet<T> |
empty(java.util.Comparator<? super T> comparator) |
boolean |
equals(java.lang.Object o)
In Vavr there are four basic classes of collections:
Seq (sequential elements)
Set (distinct elements)
Map (indexed elements)
Multimap (indexed collections)
Two collection instances of these classes are equal if and only if both collections
belong to the same basic collection class (Seq, Set, Map or Multimap)
contain the same elements
have the same element order, if the collections are of type Seq
Two Map/Multimap elements, resp.
|
static <T> TreeSet<T> |
fill(java.util.Comparator<? super T> comparator,
int n,
java.util.function.Supplier<? extends T> s)
Returns a TreeSet containing tuples returned by
n calls to a given Supplier s. |
static <T extends java.lang.Comparable<? super T>> |
fill(int n,
java.util.function.Supplier<? extends T> s)
Returns a TreeSet containing tuples returned by
n calls to a given Supplier s. |
TreeSet<T> |
filter(java.util.function.Predicate<? super T> predicate)
Returns a new traversable consisting of all elements which satisfy the given predicate.
|
TreeSet<T> |
filterNot(java.util.function.Predicate<? super T> predicate)
Returns a new traversable consisting of all elements which do not satisfy the given predicate.
|
<U> TreeSet<U> |
flatMap(java.util.Comparator<? super U> comparator,
java.util.function.Function<? super T,? extends java.lang.Iterable<? extends U>> mapper)
Same as
SortedSet.flatMap(Function) but using a specific comparator for values of the codomain of the given
mapper. |
<U> Set<U> |
flatMap(java.util.function.Function<? super T,? extends java.lang.Iterable<? extends U>> mapper)
FlatMaps this Traversable.
|
<U> U |
foldRight(U zero,
java.util.function.BiFunction<? super T,? super U,? extends U> f)
Folds this elements from the right, starting with
zero and successively calling combine. |
<C> Map<C,TreeSet<T>> |
groupBy(java.util.function.Function<? super T,? extends C> classifier)
Groups this elements by classifying the elements.
|
Iterator<TreeSet<T>> |
grouped(int size)
Groups this
Traversable into fixed size blocks. |
boolean |
hasDefiniteSize()
Checks if this Traversable is known to have a finite size.
|
int |
hashCode()
Returns the hash code of this collection.
|
T |
head()
Returns the first element of a non-empty Traversable.
|
Option<T> |
headOption()
Returns the first element of a non-empty Traversable as
Option. |
TreeSet<T> |
init()
Dual of Traversable.tail(), returning all elements except the last.
|
Option<TreeSet<T>> |
initOption()
Dual of Traversable.tailOption(), returning all elements except the last as
Option. |
TreeSet<T> |
intersect(Set<? extends T> elements)
Computes the intersection between this set and another set.
|
boolean |
isAsync()
A
TreeSet is computed synchronously. |
boolean |
isEmpty()
Checks if this Traversable is empty.
|
boolean |
isLazy()
A
TreeSet is computed eagerly. |
boolean |
isTraversableAgain()
Checks if this Traversable can be repeatedly traversed.
|
Iterator<T> |
iterator()
An iterator by means of head() and tail().
|
T |
last()
Dual of Traversable.head(), returning the last element.
|
int |
length()
Computes the number of elements of this Traversable.
|
<U> TreeSet<U> |
map(java.util.Comparator<? super U> comparator,
java.util.function.Function<? super T,? extends U> mapper)
Same as
SortedSet.map(Function) but using a specific comparator for values of the codomain of the given
mapper. |
<U> Set<U> |
map(java.util.function.Function<? super T,? extends U> mapper)
Maps the elements of this
Traversable to elements of a new type preserving their order, if any. |
static <T> TreeSet<T> |
narrow(TreeSet<? extends T> treeSet)
Narrows a widened
TreeSet<? extends T> to TreeSet<T>
by performing a type-safe cast. |
static <T> TreeSet<T> |
of(java.util.Comparator<? super T> comparator,
T... values) |
static <T> TreeSet<T> |
of(java.util.Comparator<? super T> comparator,
T value) |
static <T extends java.lang.Comparable<? super T>> |
of(T... values) |
static <T extends java.lang.Comparable<? super T>> |
of(T value) |
static TreeSet<java.lang.Boolean> |
ofAll(boolean... elements)
Creates a TreeSet from boolean values.
|
static TreeSet<java.lang.Byte> |
ofAll(byte... elements)
Creates a TreeSet from byte values.
|
static TreeSet<java.lang.Character> |
ofAll(char... elements)
Creates a TreeSet from char values.
|
static <T> TreeSet<T> |
ofAll(java.util.Comparator<? super T> comparator,
java.lang.Iterable<? extends T> values) |
static <T> TreeSet<T> |
ofAll(java.util.Comparator<? super T> comparator,
java.util.stream.Stream<? extends T> javaStream) |
static TreeSet<java.lang.Double> |
ofAll(double... elements)
Creates a TreeSet from double values.
|
static TreeSet<java.lang.Float> |
ofAll(float... elements)
Creates a TreeSet from float values.
|
static TreeSet<java.lang.Integer> |
ofAll(int... elements)
Creates a TreeSet from int values.
|
static <T extends java.lang.Comparable<? super T>> |
ofAll(java.lang.Iterable<? extends T> values) |
static TreeSet<java.lang.Long> |
ofAll(long... elements)
Creates a TreeSet from long values.
|
static TreeSet<java.lang.Short> |
ofAll(short... elements)
Creates a TreeSet from short values.
|
static <T extends java.lang.Comparable<? super T>> |
ofAll(java.util.stream.Stream<? extends T> javaStream) |
TreeSet<T> |
orElse(java.lang.Iterable<? extends T> other)
Returns this
TreeSet if it is nonempty,
otherwise TreeSet created from iterable, using existing comparator. |
TreeSet<T> |
orElse(java.util.function.Supplier<? extends java.lang.Iterable<? extends T>> supplier)
Returns this
TreeSet if it is nonempty,
otherwise TreeSet created from result of evaluating supplier, using existing comparator. |
Tuple2<TreeSet<T>,TreeSet<T>> |
partition(java.util.function.Predicate<? super T> predicate)
Creates a partition of this
Traversable by splitting this elements in two in distinct traversables
according to a predicate. |
TreeSet<T> |
peek(java.util.function.Consumer<? super T> action)
Performs the given
action on the first element if this is an eager implementation. |
static TreeSet<java.lang.Character> |
range(char from,
char toExclusive) |
static TreeSet<java.lang.Integer> |
range(int from,
int toExclusive)
Creates a TreeSet of int numbers starting from
from, extending to toExclusive - 1. |
static TreeSet<java.lang.Long> |
range(long from,
long toExclusive)
Creates a TreeSet of long numbers starting from
from, extending to toExclusive - 1. |
static TreeSet<java.lang.Character> |
rangeBy(char from,
char toExclusive,
int step) |
static TreeSet<java.lang.Double> |
rangeBy(double from,
double toExclusive,
double step) |
static TreeSet<java.lang.Integer> |
rangeBy(int from,
int toExclusive,
int step)
Creates a TreeSet of int numbers starting from
from, extending to toExclusive - 1,
with step. |
static TreeSet<java.lang.Long> |
rangeBy(long from,
long toExclusive,
long step)
Creates a TreeSet of long numbers starting from
from, extending to toExclusive - 1,
with step. |
static TreeSet<java.lang.Character> |
rangeClosed(char from,
char toInclusive) |
static TreeSet<java.lang.Integer> |
rangeClosed(int from,
int toInclusive)
Creates a TreeSet of int numbers starting from
from, extending to toInclusive. |
static TreeSet<java.lang.Long> |
rangeClosed(long from,
long toInclusive)
Creates a TreeSet of long numbers starting from
from, extending to toInclusive. |
static TreeSet<java.lang.Character> |
rangeClosedBy(char from,
char toInclusive,
int step) |
static TreeSet<java.lang.Double> |
rangeClosedBy(double from,
double toInclusive,
double step) |
static TreeSet<java.lang.Integer> |
rangeClosedBy(int from,
int toInclusive,
int step)
Creates a TreeSet of int numbers starting from
from, extending to toInclusive,
with step. |
static TreeSet<java.lang.Long> |
rangeClosedBy(long from,
long toInclusive,
long step)
Creates a TreeSet of long numbers starting from
from, extending to toInclusive,
with step. |
TreeSet<T> |
remove(T element)
Removes a specific element from this set, if present.
|
TreeSet<T> |
removeAll(java.lang.Iterable<? extends T> elements)
Removes all of the given elements from this set, if present.
|
TreeSet<T> |
replace(T currentElement,
T newElement)
Replaces the first occurrence (if exists) of the given currentElement with newElement.
|
TreeSet<T> |
replaceAll(T currentElement,
T newElement)
Replaces all occurrences of the given currentElement with newElement.
|
TreeSet<T> |
retainAll(java.lang.Iterable<? extends T> elements)
Keeps all occurrences of the given elements from this.
|
TreeSet<T> |
scan(T zero,
java.util.function.BiFunction<? super T,? super T,? extends T> operation)
Computes a prefix scan of the elements of the collection.
|
<U> Set<U> |
scanLeft(U zero,
java.util.function.BiFunction<? super U,? super T,? extends U> operation)
Produces a collection containing cumulative results of applying the
operator going left to right.
|
<U> Set<U> |
scanRight(U zero,
java.util.function.BiFunction<? super T,? super U,? extends U> operation)
Produces a collection containing cumulative results of applying the
operator going right to left.
|
Iterator<TreeSet<T>> |
slideBy(java.util.function.Function<? super T,?> classifier)
Slides a non-overlapping window of a variable size over this
Traversable. |
Iterator<TreeSet<T>> |
sliding(int size)
Slides a window of a specific
size and step size 1 over this Traversable by calling
Traversable.sliding(int, int). |
Iterator<TreeSet<T>> |
sliding(int size,
int step)
Slides a window of a specific
size and step size over this Traversable. |
Tuple2<TreeSet<T>,TreeSet<T>> |
span(java.util.function.Predicate<? super T> predicate)
Returns a tuple where the first element is the longest prefix of elements that satisfy the given
predicate and the second element is the remainder. |
java.lang.String |
stringPrefix()
Returns the name of this Value type, which is used by toString().
|
static <T> TreeSet<T> |
tabulate(java.util.Comparator<? super T> comparator,
int n,
java.util.function.Function<? super java.lang.Integer,? extends T> f)
Returns a TreeSet containing
n values of a given Function f
over a range of integer values from 0 to n - 1. |
static <T extends java.lang.Comparable<? super T>> |
tabulate(int n,
java.util.function.Function<? super java.lang.Integer,? extends T> f)
Returns a TreeSet containing
n values of a given Function f
over a range of integer values from 0 to n - 1. |
TreeSet<T> |
tail()
Drops the first element of a non-empty Traversable.
|
Option<TreeSet<T>> |
tailOption()
Drops the first element of a non-empty Traversable and returns an
Option. |
TreeSet<T> |
take(int n)
Takes the first n elements of this or all elements, if this length < n.
|
TreeSet<T> |
takeRight(int n)
Takes the last n elements of this or all elements, if this length < n.
|
TreeSet<T> |
takeUntil(java.util.function.Predicate<? super T> predicate)
Takes elements until the predicate holds for the current element.
|
TreeSet<T> |
takeWhile(java.util.function.Predicate<? super T> predicate)
Takes elements while the predicate holds for the current element.
|
java.util.TreeSet<T> |
toJavaSet()
Converts this Vavr
Set to a java.util.Set while preserving characteristics
like insertion order (LinkedHashSet) and sort order (SortedSet). |
java.lang.String |
toString()
Clarifies that values have a proper toString() method implemented.
|
<U> U |
transform(java.util.function.Function<? super TreeSet<T>,? extends U> f)
Transforms this
TreeSet. |
TreeSet<T> |
union(Set<? extends T> elements)
Adds all of the elements of
that set to this set, if not already present. |
<U> TreeSet<Tuple2<T,U>> |
zip(java.lang.Iterable<? extends U> that)
Returns a traversable formed from this traversable and another Iterable collection by combining
corresponding elements in pairs.
|
<U> TreeSet<Tuple2<T,U>> |
zipAll(java.lang.Iterable<? extends U> that,
T thisElem,
U thatElem)
Returns a traversable formed from this traversable and another Iterable by combining corresponding elements in
pairs.
|
<U,R> TreeSet<R> |
zipWith(java.lang.Iterable<? extends U> that,
java.util.function.BiFunction<? super T,? super U,? extends R> mapper)
Returns a traversable formed from this traversable and another Iterable collection by mapping elements.
|
TreeSet<Tuple2<T,java.lang.Integer>> |
zipWithIndex()
Zips this traversable with its indices.
|
<U> SortedSet<U> |
zipWithIndex(java.util.function.BiFunction<? super T,? super java.lang.Integer,? extends U> mapper)
Zips this traversable with its indices by applying mapper provided.
|
clone, finalize, getClass, notify, notifyAll, wait, wait, waitisDistinct, narrowarrangeBy, average, containsAll, count, existsUnique, find, findLast, fold, foldLeft, forEachWithIndex, get, isSequential, isSingleValued, lastOption, max, maxBy, maxBy, min, minBy, minBy, mkCharSeq, mkCharSeq, mkCharSeq, mkString, mkString, mkString, narrow, nonEmpty, product, reduce, reduceLeft, reduceLeftOption, reduceOption, reduceRight, reduceRightOption, single, singleOption, size, spliterator, sum, toLinkedMap, toMap, toSortedMap, toSortedMap, unzip, unzip3collect, collect, corresponds, eq, exists, forAll, forEach, getOrElse, getOrElse, getOrElseThrow, getOrElseTry, getOrNull, narrow, out, out, stderr, stdout, toArray, toCharSeq, toCompletableFuture, toEither, toEither, toInvalid, toInvalid, toJavaArray, toJavaArray, toJavaArray, toJavaCollection, toJavaList, toJavaList, toJavaMap, toJavaMap, toJavaMap, toJavaOptional, toJavaParallelStream, toJavaSet, toJavaStream, toLeft, toLeft, toLinkedMap, toLinkedMap, toLinkedSet, toList, toMap, toMap, toOption, toPriorityQueue, toPriorityQueue, toQueue, toRight, toRight, toSet, toSortedMap, toSortedMap, toSortedMap, toSortedMap, toSortedSet, toSortedSet, toStream, toTree, toTree, toTry, toTry, toValid, toValid, toValidation, toValidation, toVectorpublic static <T extends java.lang.Comparable<? super T>> java.util.stream.Collector<T,java.util.ArrayList<T>,TreeSet<T>> collector()
Collector which may be used in conjunction with
Stream.collect(java.util.stream.Collector) to obtain a TreeSet.
The natural comparator is used to compare TreeSet elements.
T - Component type of the List.public static <T> java.util.stream.Collector<T,java.util.ArrayList<T>,TreeSet<T>> collector(java.util.Comparator<? super T> comparator)
Collector which may be used in conjunction with
Stream.collect(java.util.stream.Collector) to obtain a TreeSet.T - Component type of the List.comparator - An element comparatorpublic static <T extends java.lang.Comparable<? super T>> TreeSet<T> empty()
public static <T> TreeSet<T> empty(java.util.Comparator<? super T> comparator)
public static <T> TreeSet<T> narrow(TreeSet<? extends T> treeSet)
TreeSet<? extends T> to TreeSet<T>
by performing a type-safe cast. This is eligible because immutable/read-only
collections are covariant.
CAUTION: The underlying Comparator might fail!
T - Component type of the TreeSet.treeSet - A TreeSet.treeSet instance as narrowed type TreeSet<T>.public static <T extends java.lang.Comparable<? super T>> TreeSet<T> of(T value)
public static <T> TreeSet<T> of(java.util.Comparator<? super T> comparator, T value)
@SafeVarargs public static <T extends java.lang.Comparable<? super T>> TreeSet<T> of(T... values)
@SafeVarargs public static <T> TreeSet<T> of(java.util.Comparator<? super T> comparator, T... values)
public static <T> TreeSet<T> tabulate(java.util.Comparator<? super T> comparator, int n, java.util.function.Function<? super java.lang.Integer,? extends T> f)
n values of a given Function f
over a range of integer values from 0 to n - 1.T - Component type of the TreeSetcomparator - The comparator used to sort the elementsn - The number of elements in the TreeSetf - The Function computing element valuesf(0),f(1), ..., f(n - 1)java.lang.NullPointerException - if comparator or f are nullpublic static <T extends java.lang.Comparable<? super T>> TreeSet<T> tabulate(int n, java.util.function.Function<? super java.lang.Integer,? extends T> f)
n values of a given Function f
over a range of integer values from 0 to n - 1.
The underlying comparator is the natural comparator of T.T - Component type of the TreeSetn - The number of elements in the TreeSetf - The Function computing element valuesf(0),f(1), ..., f(n - 1)java.lang.NullPointerException - if f is nullpublic static <T> TreeSet<T> fill(java.util.Comparator<? super T> comparator, int n, java.util.function.Supplier<? extends T> s)
n calls to a given Supplier s.T - Component type of the TreeSetcomparator - The comparator used to sort the elementsn - The number of elements in the TreeSets - The Supplier computing element valuesn, where each element contains the result supplied by s.java.lang.NullPointerException - if comparator or s are nullpublic static <T extends java.lang.Comparable<? super T>> TreeSet<T> fill(int n, java.util.function.Supplier<? extends T> s)
n calls to a given Supplier s.
The underlying comparator is the natural comparator of T.T - Component type of the TreeSetn - The number of elements in the TreeSets - The Supplier computing element valuesn, where each element contains the result supplied by s.java.lang.NullPointerException - if s is nullpublic static <T extends java.lang.Comparable<? super T>> TreeSet<T> ofAll(java.lang.Iterable<? extends T> values)
public static <T> TreeSet<T> ofAll(java.util.Comparator<? super T> comparator, java.lang.Iterable<? extends T> values)
public static <T extends java.lang.Comparable<? super T>> TreeSet<T> ofAll(java.util.stream.Stream<? extends T> javaStream)
public static <T> TreeSet<T> ofAll(java.util.Comparator<? super T> comparator, java.util.stream.Stream<? extends T> javaStream)
public static TreeSet<java.lang.Boolean> ofAll(boolean... elements)
elements - boolean valuesjava.lang.NullPointerException - if elements is nullpublic static TreeSet<java.lang.Byte> ofAll(byte... elements)
elements - byte valuesjava.lang.NullPointerException - if elements is nullpublic static TreeSet<java.lang.Character> ofAll(char... elements)
elements - char valuesjava.lang.NullPointerException - if elements is nullpublic static TreeSet<java.lang.Double> ofAll(double... elements)
elements - double valuesjava.lang.NullPointerException - if elements is nullpublic static TreeSet<java.lang.Float> ofAll(float... elements)
elements - float valuesjava.lang.NullPointerException - if elements is nullpublic static TreeSet<java.lang.Integer> ofAll(int... elements)
elements - int valuesjava.lang.NullPointerException - if elements is nullpublic static TreeSet<java.lang.Long> ofAll(long... elements)
elements - long valuesjava.lang.NullPointerException - if elements is nullpublic static TreeSet<java.lang.Short> ofAll(short... elements)
elements - short valuesjava.lang.NullPointerException - if elements is nullpublic static TreeSet<java.lang.Integer> range(int from, int toExclusive)
from, extending to toExclusive - 1.
Examples:
TreeSet.range(0, 0) // = TreeSet()
TreeSet.range(2, 0) // = TreeSet()
TreeSet.range(-2, 2) // = TreeSet(-2, -1, 0, 1)
from - the first numbertoExclusive - the last number + 1from >= toExclusivepublic static TreeSet<java.lang.Character> range(char from, char toExclusive)
public static TreeSet<java.lang.Integer> rangeBy(int from, int toExclusive, int step)
from, extending to toExclusive - 1,
with step.
Examples:
TreeSet.rangeBy(1, 3, 1) // = TreeSet(1, 2)
TreeSet.rangeBy(1, 4, 2) // = TreeSet(1, 3)
TreeSet.rangeBy(4, 1, -2) // = TreeSet(4, 2)
TreeSet.rangeBy(4, 1, 2) // = TreeSet()
from - the first numbertoExclusive - the last number + 1step - the stepfrom >= toInclusive and step > 0 orfrom <= toInclusive and step < 0java.lang.IllegalArgumentException - if step is zeropublic static TreeSet<java.lang.Character> rangeBy(char from, char toExclusive, int step)
public static TreeSet<java.lang.Double> rangeBy(double from, double toExclusive, double step)
public static TreeSet<java.lang.Long> range(long from, long toExclusive)
from, extending to toExclusive - 1.
Examples:
TreeSet.range(0L, 0L) // = TreeSet()
TreeSet.range(2L, 0L) // = TreeSet()
TreeSet.range(-2L, 2L) // = TreeSet(-2L, -1L, 0L, 1L)
from - the first numbertoExclusive - the last number + 1from >= toExclusivepublic static TreeSet<java.lang.Long> rangeBy(long from, long toExclusive, long step)
from, extending to toExclusive - 1,
with step.
Examples:
TreeSet.rangeBy(1L, 3L, 1L) // = TreeSet(1L, 2L)
TreeSet.rangeBy(1L, 4L, 2L) // = TreeSet(1L, 3L)
TreeSet.rangeBy(4L, 1L, -2L) // = TreeSet(4L, 2L)
TreeSet.rangeBy(4L, 1L, 2L) // = TreeSet()
from - the first numbertoExclusive - the last number + 1step - the stepfrom >= toInclusive and step > 0 orfrom <= toInclusive and step < 0java.lang.IllegalArgumentException - if step is zeropublic static TreeSet<java.lang.Integer> rangeClosed(int from, int toInclusive)
from, extending to toInclusive.
Examples:
TreeSet.rangeClosed(0, 0) // = TreeSet(0)
TreeSet.rangeClosed(2, 0) // = TreeSet()
TreeSet.rangeClosed(-2, 2) // = TreeSet(-2, -1, 0, 1, 2)
from - the first numbertoInclusive - the last numberfrom > toInclusivepublic static TreeSet<java.lang.Character> rangeClosed(char from, char toInclusive)
public static TreeSet<java.lang.Integer> rangeClosedBy(int from, int toInclusive, int step)
from, extending to toInclusive,
with step.
Examples:
TreeSet.rangeClosedBy(1, 3, 1) // = TreeSet(1, 2, 3)
TreeSet.rangeClosedBy(1, 4, 2) // = TreeSet(1, 3)
TreeSet.rangeClosedBy(4, 1, -2) // = TreeSet(4, 2)
TreeSet.rangeClosedBy(4, 1, 2) // = TreeSet()
from - the first numbertoInclusive - the last numberstep - the stepfrom > toInclusive and step > 0 orfrom < toInclusive and step < 0java.lang.IllegalArgumentException - if step is zeropublic static TreeSet<java.lang.Character> rangeClosedBy(char from, char toInclusive, int step)
public static TreeSet<java.lang.Double> rangeClosedBy(double from, double toInclusive, double step)
public static TreeSet<java.lang.Long> rangeClosed(long from, long toInclusive)
from, extending to toInclusive.
Examples:
TreeSet.rangeClosed(0L, 0L) // = TreeSet(0L)
TreeSet.rangeClosed(2L, 0L) // = TreeSet()
TreeSet.rangeClosed(-2L, 2L) // = TreeSet(-2L, -1L, 0L, 1L, 2L)
from - the first numbertoInclusive - the last numberfrom > toInclusivepublic static TreeSet<java.lang.Long> rangeClosedBy(long from, long toInclusive, long step)
from, extending to toInclusive,
with step.
Examples:
TreeSet.rangeClosedBy(1L, 3L, 1L) // = TreeSet(1L, 2L, 3L)
TreeSet.rangeClosedBy(1L, 4L, 2L) // = TreeSet(1L, 3L)
TreeSet.rangeClosedBy(4L, 1L, -2L) // = TreeSet(4L, 2L)
TreeSet.rangeClosedBy(4L, 1L, 2L) // = TreeSet()
from - the first numbertoInclusive - the last numberstep - the stepfrom > toInclusive and step > 0 orfrom < toInclusive and step < 0java.lang.IllegalArgumentException - if step is zeropublic TreeSet<T> add(T element)
Setpublic TreeSet<T> addAll(java.lang.Iterable<? extends T> elements)
Setpublic <R> TreeSet<R> collect(PartialFunction<? super T,? extends R> partialFunction)
TraversablepartialFunction by mapping the elements to type R.
More specifically, for each of this elements in iteration order first it is checked
partialFunction.isDefinedAt(element)
If the elements makes it through that filter, the mapped instance is added to the result collection
R newElement = partialFunction.apply(element)
Note:If this Traversable is ordered (i.e. extends Ordered,
the caller of collect has to ensure that the elements are comparable (i.e. extend Comparable).collect in interface Set<T>collect in interface SortedSet<T>collect in interface Traversable<T>R - The new element typepartialFunction - A function that is not necessarily defined of all elements of this traversable.Traversable instance containing elements of type Rpublic java.util.Comparator<T> comparator()
Orderedcomparator in interface Ordered<T>public TreeSet<T> diff(Set<? extends T> elements)
Set
See also Set.removeAll(Iterable).
public boolean contains(T element)
Valueexists(e -> Objects.equals(e, element)), tests if the given element is contained.public TreeSet<T> distinct()
Traversableequals.public TreeSet<T> distinctBy(java.util.Comparator<? super T> comparator)
Traversablecomparator.distinctBy in interface Set<T>distinctBy in interface SortedSet<T>distinctBy in interface Traversable<T>comparator - A comparatorTraversable containing this elements without duplicatespublic <U> TreeSet<T> distinctBy(java.util.function.Function<? super T,? extends U> keyExtractor)
Traversableequals.
The elements of the result are determined in the order of their occurrence - first match wins.
distinctBy in interface Set<T>distinctBy in interface SortedSet<T>distinctBy in interface Traversable<T>U - key typekeyExtractor - A key extractorTraversable containing this elements without duplicatespublic TreeSet<T> drop(int n)
Traversabledrop in interface Set<T>drop in interface SortedSet<T>drop in interface Traversable<T>n - The number of elements to drop.public TreeSet<T> dropRight(int n)
TraversabledropRight in interface Set<T>dropRight in interface SortedSet<T>dropRight in interface Traversable<T>n - The number of elements to drop.public TreeSet<T> dropUntil(java.util.function.Predicate<? super T> predicate)
TraversabledropUntil in interface Set<T>dropUntil in interface SortedSet<T>dropUntil in interface Traversable<T>predicate - A condition tested subsequently for this elements.public TreeSet<T> dropWhile(java.util.function.Predicate<? super T> predicate)
Traversable
Note: This is essentially the same as dropUntil(predicate.negate()).
It is intended to be used with method references, which cannot be negated directly.
dropWhile in interface Set<T>dropWhile in interface SortedSet<T>dropWhile in interface Traversable<T>predicate - A condition tested subsequently for this elements.public TreeSet<T> filter(java.util.function.Predicate<? super T> predicate)
Traversablepublic TreeSet<T> filterNot(java.util.function.Predicate<? super T> predicate)
TraversableThe default implementation is equivalent to
filter(predicate.negate()public <U> TreeSet<U> flatMap(java.util.Comparator<? super U> comparator, java.util.function.Function<? super T,? extends java.lang.Iterable<? extends U>> mapper)
SortedSetSortedSet.flatMap(Function) but using a specific comparator for values of the codomain of the given
mapper.public <U> Set<U> flatMap(java.util.function.Function<? super T,? extends java.lang.Iterable<? extends U>> mapper)
Traversablepublic <U> U foldRight(U zero,
java.util.function.BiFunction<? super T,? super U,? extends U> f)
Traversablezero and successively calling combine.
Example:
// = "!cba"
List("a", "b", "c").foldRight("!", (x, xs) -> xs + x)
public <C> Map<C,TreeSet<T>> groupBy(java.util.function.Function<? super T,? extends C> classifier)
TraversablegroupBy in interface Set<T>groupBy in interface SortedSet<T>groupBy in interface Traversable<T>C - classified class typeclassifier - A function which classifies elements into classesTraversable.arrangeBy(Function)public Iterator<TreeSet<T>> grouped(int size)
TraversableTraversable into fixed size blocks.
Let length be the length of this Iterable. Then grouped is defined as follows:
this.isEmpty(), the resulting Iterator is empty.size <= length, the resulting Iterator will contain length / size blocks of size
size and maybe a non-empty block of size length % size, if there are remaining elements.size > length, the resulting Iterator will contain one block of size length.
[].grouped(1) = []
[].grouped(0) throws
[].grouped(-1) throws
[1,2,3,4].grouped(2) = [[1,2],[3,4]]
[1,2,3,4,5].grouped(2) = [[1,2],[3,4],[5]]
[1,2,3,4].grouped(5) = [[1,2,3,4]]
Please note that grouped(int) is a special case of Traversable.sliding(int, int), i.e.
grouped(size) is the same as sliding(size, size).public boolean hasDefiniteSize()
TraversableThis method should be implemented by classes only, i.e. not by interfaces.
hasDefiniteSize in interface Traversable<T>public T head()
Traversablehead in interface Traversable<T>public Option<T> headOption()
TraversableOption.headOption in interface Traversable<T>Some(element) or None if this is empty.public TreeSet<T> init()
Traversablepublic Option<TreeSet<T>> initOption()
TraversableOption.initOption in interface Set<T>initOption in interface SortedSet<T>initOption in interface Traversable<T>Some(traversable) or None if this is empty.public TreeSet<T> intersect(Set<? extends T> elements)
Set
See also Set.retainAll(Iterable).
public boolean isAsync()
TreeSet is computed synchronously.public boolean isEmpty()
Traversablepublic boolean isLazy()
TreeSet is computed eagerly.public boolean isTraversableAgain()
TraversableThis method should be implemented by classes only, i.e. not by interfaces.
isTraversableAgain in interface Traversable<T>public Iterator<T> iterator()
Traversablepublic T last()
Traversablelast in interface Traversable<T>public int length()
Traversable
Same as Traversable.size().
public <U> TreeSet<U> map(java.util.Comparator<? super U> comparator, java.util.function.Function<? super T,? extends U> mapper)
SortedSetSortedSet.map(Function) but using a specific comparator for values of the codomain of the given
mapper.public <U> Set<U> map(java.util.function.Function<? super T,? extends U> mapper)
TraversableTraversable to elements of a new type preserving their order, if any.public TreeSet<T> orElse(java.lang.Iterable<? extends T> other)
TreeSet if it is nonempty,
otherwise TreeSet created from iterable, using existing comparator.public TreeSet<T> orElse(java.util.function.Supplier<? extends java.lang.Iterable<? extends T>> supplier)
TreeSet if it is nonempty,
otherwise TreeSet created from result of evaluating supplier, using existing comparator.orElse in interface Set<T>orElse in interface SortedSet<T>orElse in interface Traversable<T>supplier - An alternative TraversableTreeSet if it is nonempty,
otherwise TreeSet created from result of evaluating supplier, using existing comparator.public Tuple2<TreeSet<T>,TreeSet<T>> partition(java.util.function.Predicate<? super T> predicate)
TraversableTraversable by splitting this elements in two in distinct traversables
according to a predicate.partition in interface Set<T>partition in interface SortedSet<T>partition in interface Traversable<T>predicate - A predicate which classifies an element if it is in the first or the second traversable.Traversable contains all elements that satisfy the given predicate, the second Traversable contains all elements that don't. The original order of elements is preserved.public TreeSet<T> peek(java.util.function.Consumer<? super T> action)
Valueaction on the first element if this is an eager implementation.
Performs the given action on all elements (the first immediately, successive deferred),
if this is a lazy implementation.public TreeSet<T> remove(T element)
Setpublic TreeSet<T> removeAll(java.lang.Iterable<? extends T> elements)
Setpublic TreeSet<T> replace(T currentElement, T newElement)
Traversablereplace in interface Set<T>replace in interface SortedSet<T>replace in interface Traversable<T>currentElement - An element to be substituted.newElement - A replacement for currentElement.public TreeSet<T> replaceAll(T currentElement, T newElement)
TraversablereplaceAll in interface Set<T>replaceAll in interface SortedSet<T>replaceAll in interface Traversable<T>currentElement - An element to be substituted.newElement - A replacement for currentElement.public TreeSet<T> retainAll(java.lang.Iterable<? extends T> elements)
Traversablepublic TreeSet<T> scan(T zero, java.util.function.BiFunction<? super T,? super T,? extends T> operation)
Traversablescan in interface Set<T>scan in interface SortedSet<T>scan in interface Traversable<T>zero - neutral element for the operator opoperation - the associative operator for the scanpublic <U> Set<U> scanLeft(U zero, java.util.function.BiFunction<? super U,? super T,? extends U> operation)
TraversablescanLeft in interface Set<T>scanLeft in interface SortedSet<T>scanLeft in interface Traversable<T>U - the type of the elements in the resulting collectionzero - the initial valueoperation - the binary operator applied to the intermediate result and the elementpublic <U> Set<U> scanRight(U zero, java.util.function.BiFunction<? super T,? super U,? extends U> operation)
TraversablescanRight in interface Set<T>scanRight in interface SortedSet<T>scanRight in interface Traversable<T>U - the type of the elements in the resulting collectionzero - the initial valueoperation - the binary operator applied to the intermediate result and the elementpublic Iterator<TreeSet<T>> slideBy(java.util.function.Function<? super T,?> classifier)
TraversableTraversable.
Each window contains elements with the same class, as determined by classifier. Two consecutive
values in this Traversable will be in the same window only if classifier returns equal
values for them. Otherwise, the values will constitute the last element of the previous window and the
first element of the next window.
Examples:
[].slideBy(Function.identity()) = []
[1,2,3,4,4,5].slideBy(Function.identity()) = [[1],[2],[3],[4,4],[5]]
[1,2,3,10,12,5,7,20,29].slideBy(x -> x/10) = [[1,2,3],[10,12],[5,7],[20,29]]
public Iterator<TreeSet<T>> sliding(int size)
Traversablesize and step size 1 over this Traversable by calling
Traversable.sliding(int, int).public Iterator<TreeSet<T>> sliding(int size, int step)
Traversablesize and step size over this Traversable.
Examples:
[].sliding(1,1) = []
[1,2,3,4,5].sliding(2,3) = [[1,2],[4,5]]
[1,2,3,4,5].sliding(2,4) = [[1,2],[5]]
[1,2,3,4,5].sliding(2,5) = [[1,2]]
[1,2,3,4].sliding(5,3) = [[1,2,3,4]]
public Tuple2<TreeSet<T>,TreeSet<T>> span(java.util.function.Predicate<? super T> predicate)
Traversablepredicate and the second element is the remainder.public TreeSet<T> tail()
Traversablepublic Option<TreeSet<T>> tailOption()
TraversableOption.tailOption in interface Set<T>tailOption in interface SortedSet<T>tailOption in interface Traversable<T>Some(traversable) or None if this is empty.public TreeSet<T> take(int n)
Traversable
The result is equivalent to sublist(0, max(0, min(length(), n))) but does not throw if n < 0 or
n > length().
In the case of n < 0 the empty instance is returned, in the case of n > length() this is returned.
public TreeSet<T> takeRight(int n)
Traversable
The result is equivalent to sublist(max(0, min(length(), length() - n)), n), i.e. takeRight will not
throw if n < 0 or n > length().
In the case of n < 0 the empty instance is returned, in the case of n > length() this is returned.
takeRight in interface Set<T>takeRight in interface SortedSet<T>takeRight in interface Traversable<T>n - The number of elements to take.public TreeSet<T> takeUntil(java.util.function.Predicate<? super T> predicate)
Traversable
Note: This is essentially the same as takeWhile(predicate.negate()). It is intended to be used with
method references, which cannot be negated directly.
takeUntil in interface Set<T>takeUntil in interface SortedSet<T>takeUntil in interface Traversable<T>predicate - A condition tested subsequently for this elements.public TreeSet<T> takeWhile(java.util.function.Predicate<? super T> predicate)
TraversabletakeWhile in interface Set<T>takeWhile in interface SortedSet<T>takeWhile in interface Traversable<T>predicate - A condition tested subsequently for the contained elements.public <U> U transform(java.util.function.Function<? super TreeSet<T>,? extends U> f)
TreeSet.U - Type of transformation resultf - A transformationUjava.lang.NullPointerException - if f is nullpublic java.util.TreeSet<T> toJavaSet()
SetSet to a java.util.Set while preserving characteristics
like insertion order (LinkedHashSet) and sort order (SortedSet).public TreeSet<T> union(Set<? extends T> elements)
Setthat set to this set, if not already present.
See also Set.addAll(Iterable).
public <U> TreeSet<Tuple2<T,U>> zip(java.lang.Iterable<? extends U> that)
Traversable
The length of the returned traversable is the minimum of the lengths of this traversable and that
iterable.
zip in interface Set<T>zip in interface SortedSet<T>zip in interface Traversable<T>U - The type of the second half of the returned pairs.that - The Iterable providing the second half of each result pair.that iterable.public <U,R> TreeSet<R> zipWith(java.lang.Iterable<? extends U> that, java.util.function.BiFunction<? super T,? super U,? extends R> mapper)
Traversable
The length of the returned traversable is the minimum of the lengths of this traversable and that
iterable.
zipWith in interface Set<T>zipWith in interface SortedSet<T>zipWith in interface Traversable<T>U - The type of the second parameter of the mapper.R - The type of the mapped elements.that - The Iterable providing the second parameter of the mapper.mapper - a mapper.that iterable.public <U> TreeSet<Tuple2<T,U>> zipAll(java.lang.Iterable<? extends U> that, T thisElem, U thatElem)
Traversable
The length of the returned traversable is the maximum of the lengths of this traversable and that
iterable.
Special case: if this traversable is shorter than that elements, and that elements contains duplicates, the resulting traversable may be shorter than the maximum of the lengths of this and that because a traversable contains an element at most once.
If this Traversable is shorter than that, thisElem values are used to fill the result. If that is shorter than this Traversable, thatElem values are used to fill the result.
zipAll in interface Set<T>zipAll in interface SortedSet<T>zipAll in interface Traversable<T>U - The type of the second half of the returned pairs.that - The Iterable providing the second half of each result pair.thisElem - The element to be used to fill up the result if this traversable is shorter than that.thatElem - The element to be used to fill up the result if that is shorter than this traversable.public TreeSet<Tuple2<T,java.lang.Integer>> zipWithIndex()
TraversablezipWithIndex in interface Set<T>zipWithIndex in interface SortedSet<T>zipWithIndex in interface Traversable<T>public <U> SortedSet<U> zipWithIndex(java.util.function.BiFunction<? super T,? super java.lang.Integer,? extends U> mapper)
TraversablezipWithIndex in interface Set<T>zipWithIndex in interface SortedSet<T>zipWithIndex in interface Traversable<T>U - The type of the mapped elements.mapper - a mapper.public boolean equals(java.lang.Object o)
TraversableNotes:
public int hashCode()
Traversable
int hash = 1;
for (T t : this) { hash = hash * 31 + Objects.hashCode(t); }
Collections with arbitrary iteration order are hashed in a way such that the hash of a fixed number of elements is independent of their iteration order.
int hash = 1;
for (T t : this) { hash += Objects.hashCode(t); }
Please note that the particular hashing algorithms may change in a future version of Vavr.
public final class Hashed<K> {
private final K key;
private final Lazy<Integer> hashCode;
public Hashed(K key) {
this.key = key;
this.hashCode = Lazy.of(() -> Objects.hashCode(key));
}
public K key() {
return key;
}
@Override
public boolean equals(Object o) {
if (o == key) {
return true;
} else if (key != null && o instanceof Hashed) {
final Hashed that = (Hashed) o;
return key.equals(that.key);
} else {
return false;
}
}
@Override
public int hashCode() {
return hashCode.get();
}
@Override
public String toString() {
return "Hashed(" + (key == null ? "null" : key.toString()) + ")";
}
}
public java.lang.String stringPrefix()
ValuestringPrefix in interface Value<T>public java.lang.String toString()
ValueSee Object.toString().