Class LinkedHashSet<T>
- java.lang.Object
-
- io.vavr.collection.LinkedHashSet<T>
-
- Type Parameters:
T
- Component type
- All Implemented Interfaces:
Foldable<T>
,Set<T>
,Traversable<T>
,Function1<T,java.lang.Boolean>
,Iterable<T>
,Value<T>
,java.io.Serializable
,java.lang.Iterable<T>
,java.util.function.Function<T,java.lang.Boolean>
public final class LinkedHashSet<T> extends java.lang.Object implements Set<T>, java.io.Serializable
An immutableHashSet
implementation that has predictable (insertion-order) iteration.- See Also:
- Serialized Form
-
-
Method Summary
Modifier and Type Method Description LinkedHashSet<T>
add(T element)
Add the given element to this set, replacing existing one if it is already contained.LinkedHashSet<T>
addAll(java.lang.Iterable<? extends T> elements)
Adds all of the given elements to this set, replacing existing one if they are not already contained.<R> LinkedHashSet<R>
collect(PartialFunction<? super T,? extends R> partialFunction)
Collects all elements that are in the domain of the givenpartialFunction
by mapping the elements to typeR
.static <T> java.util.stream.Collector<T,java.util.ArrayList<T>,LinkedHashSet<T>>
collector()
Returns aCollector
which may be used in conjunction withStream.collect(Collector)
to obtain aLinkedHashSet
.boolean
contains(T element)
Shortcut forexists(e -> Objects.equals(e, element))
, tests if the givenelement
is contained.LinkedHashSet<T>
diff(Set<? extends T> elements)
Calculates the difference between this set and another set.LinkedHashSet<T>
distinct()
Returns a new version of this which contains no duplicates.LinkedHashSet<T>
distinctBy(java.util.Comparator<? super T> comparator)
Returns a new version of this which contains no duplicates.<U> LinkedHashSet<T>
distinctBy(java.util.function.Function<? super T,? extends U> keyExtractor)
Returns a new version of this which contains no duplicates.LinkedHashSet<T>
drop(int n)
Drops the first n elements of this or all elements, if this length < n.LinkedHashSet<T>
dropRight(int n)
Drops the last n elements of this or all elements, if this length < n.LinkedHashSet<T>
dropUntil(java.util.function.Predicate<? super T> predicate)
Drops elements until the predicate holds for the current element.LinkedHashSet<T>
dropWhile(java.util.function.Predicate<? super T> predicate)
Drops elements while the predicate holds for the current element.static <T> LinkedHashSet<T>
empty()
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> LinkedHashSet<T>
fill(int n, java.util.function.Supplier<? extends T> s)
Returns a LinkedHashSet containing tuples returned byn
calls to a given Suppliers
.LinkedHashSet<T>
filter(java.util.function.Predicate<? super T> predicate)
Returns a new traversable consisting of all elements which satisfy the given predicate.LinkedHashSet<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> LinkedHashSet<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 withzero
and successively callingcombine
.<C> Map<C,LinkedHashSet<T>>
groupBy(java.util.function.Function<? super T,? extends C> classifier)
Groups this elements by classifying the elements.Iterator<LinkedHashSet<T>>
grouped(int size)
Groups thisTraversable
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 asOption
.LinkedHashSet<T>
init()
Dual of Traversable.tail(), returning all elements except the last.Option<LinkedHashSet<T>>
initOption()
Dual of Traversable.tailOption(), returning all elements except the last asOption
.LinkedHashSet<T>
intersect(Set<? extends T> elements)
Computes the intersection between this set and another set.boolean
isAsync()
AnLinkedHashSet
's value is computed synchronously.boolean
isEmpty()
Checks if this Traversable is empty.boolean
isLazy()
AnLinkedHashSet
's value is computed eagerly.boolean
isSequential()
Checks if the elements of this Traversable appear in encounter order.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> LinkedHashSet<U>
map(java.util.function.Function<? super T,? extends U> mapper)
Maps the elements of thisTraversable
to elements of a new type preserving their order, if any.java.lang.String
mkString(java.lang.CharSequence prefix, java.lang.CharSequence delimiter, java.lang.CharSequence suffix)
Joins the string representations of this elements using a specific delimiter, prefix and suffix.static <T> LinkedHashSet<T>
narrow(LinkedHashSet<? extends T> linkedHashSet)
Narrows a widenedLinkedHashSet<? extends T>
toLinkedHashSet<T>
by performing a type-safe cast.static <T> LinkedHashSet<T>
of(T element)
Returns a singletonLinkedHashSet
, i.e.static <T> LinkedHashSet<T>
of(T... elements)
Creates a LinkedHashSet of the given elements.static LinkedHashSet<java.lang.Boolean>
ofAll(boolean... elements)
Creates a LinkedHashSet from boolean values.static LinkedHashSet<java.lang.Byte>
ofAll(byte... elements)
Creates a LinkedHashSet from byte values.static LinkedHashSet<java.lang.Character>
ofAll(char... elements)
Creates a LinkedHashSet from char values.static LinkedHashSet<java.lang.Double>
ofAll(double... elements)
Creates a LinkedHashSet from double values.static LinkedHashSet<java.lang.Float>
ofAll(float... elements)
Creates a LinkedHashSet from float values.static LinkedHashSet<java.lang.Integer>
ofAll(int... elements)
Creates a LinkedHashSet from int values.static LinkedHashSet<java.lang.Long>
ofAll(long... elements)
Creates a LinkedHashSet from long values.static LinkedHashSet<java.lang.Short>
ofAll(short... elements)
Creates a LinkedHashSet from short values.static <T> LinkedHashSet<T>
ofAll(java.lang.Iterable<? extends T> elements)
Creates a LinkedHashSet of the given elements.static <T> LinkedHashSet<T>
ofAll(java.util.stream.Stream<? extends T> javaStream)
Creates a LinkedHashSet that contains the elements of the givenStream
.LinkedHashSet<T>
orElse(java.lang.Iterable<? extends T> other)
Returns thisTraversable
if it is nonempty, otherwise return the alternative.LinkedHashSet<T>
orElse(java.util.function.Supplier<? extends java.lang.Iterable<? extends T>> supplier)
Returns thisTraversable
if it is nonempty, otherwise return the result of evaluating supplier.Tuple2<LinkedHashSet<T>,LinkedHashSet<T>>
partition(java.util.function.Predicate<? super T> predicate)
Creates a partition of thisTraversable
by splitting this elements in two in distinct traversables according to a predicate.LinkedHashSet<T>
peek(java.util.function.Consumer<? super T> action)
Performs the givenaction
on the first element if this is an eager implementation.static LinkedHashSet<java.lang.Character>
range(char from, char toExclusive)
static LinkedHashSet<java.lang.Integer>
range(int from, int toExclusive)
Creates a LinkedHashSet of int numbers starting fromfrom
, extending totoExclusive - 1
.static LinkedHashSet<java.lang.Long>
range(long from, long toExclusive)
Creates a LinkedHashSet of long numbers starting fromfrom
, extending totoExclusive - 1
.static LinkedHashSet<java.lang.Character>
rangeBy(char from, char toExclusive, int step)
static LinkedHashSet<java.lang.Double>
rangeBy(double from, double toExclusive, double step)
static LinkedHashSet<java.lang.Integer>
rangeBy(int from, int toExclusive, int step)
Creates a LinkedHashSet of int numbers starting fromfrom
, extending totoExclusive - 1
, withstep
.static LinkedHashSet<java.lang.Long>
rangeBy(long from, long toExclusive, long step)
Creates a LinkedHashSet of long numbers starting fromfrom
, extending totoExclusive - 1
, withstep
.static LinkedHashSet<java.lang.Character>
rangeClosed(char from, char toInclusive)
static LinkedHashSet<java.lang.Integer>
rangeClosed(int from, int toInclusive)
Creates a LinkedHashSet of int numbers starting fromfrom
, extending totoInclusive
.static LinkedHashSet<java.lang.Long>
rangeClosed(long from, long toInclusive)
Creates a LinkedHashSet of long numbers starting fromfrom
, extending totoInclusive
.static LinkedHashSet<java.lang.Character>
rangeClosedBy(char from, char toInclusive, int step)
static LinkedHashSet<java.lang.Double>
rangeClosedBy(double from, double toInclusive, double step)
static LinkedHashSet<java.lang.Integer>
rangeClosedBy(int from, int toInclusive, int step)
Creates a LinkedHashSet of int numbers starting fromfrom
, extending totoInclusive
, withstep
.static LinkedHashSet<java.lang.Long>
rangeClosedBy(long from, long toInclusive, long step)
Creates a LinkedHashSet of long numbers starting fromfrom
, extending totoInclusive
, withstep
.LinkedHashSet<T>
reject(java.util.function.Predicate<? super T> predicate)
Deprecated.LinkedHashSet<T>
remove(T element)
Removes a specific element from this set, if present.LinkedHashSet<T>
removeAll(java.lang.Iterable<? extends T> elements)
Removes all of the given elements from this set, if present.LinkedHashSet<T>
replace(T currentElement, T newElement)
Replaces the first occurrence (if exists) of the given currentElement with newElement.LinkedHashSet<T>
replaceAll(T currentElement, T newElement)
Replaces all occurrences of the given currentElement with newElement.LinkedHashSet<T>
retainAll(java.lang.Iterable<? extends T> elements)
Keeps all occurrences of the given elements from this.LinkedHashSet<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> LinkedHashSet<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> LinkedHashSet<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<LinkedHashSet<T>>
slideBy(java.util.function.Function<? super T,?> classifier)
Slides a non-overlapping window of a variable size over thisTraversable
.Iterator<LinkedHashSet<T>>
sliding(int size)
Slides a window of a specificsize
and step size 1 over thisTraversable
by callingTraversable.sliding(int, int)
.Iterator<LinkedHashSet<T>>
sliding(int size, int step)
Slides a window of a specificsize
andstep
size over thisTraversable
.Tuple2<LinkedHashSet<T>,LinkedHashSet<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 givenpredicate
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> LinkedHashSet<T>
tabulate(int n, java.util.function.Function<? super java.lang.Integer,? extends T> f)
Returns a LinkedHashSet containingn
values of a given Functionf
over a range of integer values from 0 ton - 1
.LinkedHashSet<T>
tail()
Drops the first element of a non-empty Traversable.Option<LinkedHashSet<T>>
tailOption()
Drops the first element of a non-empty Traversable and returns anOption
.LinkedHashSet<T>
take(int n)
Takes the first n elements of this or all elements, if this length < n.LinkedHashSet<T>
takeRight(int n)
Takes the last n elements of this or all elements, if this length < n.LinkedHashSet<T>
takeUntil(java.util.function.Predicate<? super T> predicate)
Takes elements until the predicate holds for the current element.LinkedHashSet<T>
takeWhile(java.util.function.Predicate<? super T> predicate)
Takes elements while the predicate holds for the current element.java.util.LinkedHashSet<T>
toJavaSet()
Converts this VavrSet
to ajava.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 LinkedHashSet<T>,? extends U> f)
Transforms thisLinkedHashSet
.LinkedHashSet<T>
union(Set<? extends T> elements)
Adds all of the elements ofelements
to this set, replacing existing ones if they already present.<T1,T2>
Tuple2<LinkedHashSet<T1>,LinkedHashSet<T2>>unzip(java.util.function.Function<? super T,Tuple2<? extends T1,? extends T2>> unzipper)
Unzips this elements by mapping this elements to pairs which are subsequently split into two distinct sets.<T1,T2,T3>
Tuple3<LinkedHashSet<T1>,LinkedHashSet<T2>,LinkedHashSet<T3>>unzip3(java.util.function.Function<? super T,Tuple3<? extends T1,? extends T2,? extends T3>> unzipper)
Unzips this elements by mapping this elements to triples which are subsequently split into three distinct sets.<U> LinkedHashSet<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> LinkedHashSet<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>
LinkedHashSet<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.LinkedHashSet<Tuple2<T,java.lang.Integer>>
zipWithIndex()
Zips this traversable with its indices.<U> LinkedHashSet<U>
zipWithIndex(java.util.function.BiFunction<? super T,? super java.lang.Integer,? extends U> mapper)
Returns a traversable formed from this traversable and another Iterable collection by mapping elements.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface io.vavr.Function1
andThen, arity, compose, curried, isMemoized, memoized, partial, reversed, tupled
-
Methods inherited from interface io.vavr.collection.Set
apply, isDistinct
-
Methods inherited from interface io.vavr.collection.Traversable
arrangeBy, average, containsAll, count, existsUnique, find, findLast, fold, foldLeft, forEachWithIndex, get, isOrdered, isSingleValued, lastOption, max, maxBy, maxBy, min, minBy, minBy, mkCharSeq, mkCharSeq, mkCharSeq, mkString, mkString, nonEmpty, product, reduce, reduceLeft, reduceLeftOption, reduceOption, reduceRight, reduceRightOption, single, singleOption, size, spliterator, sum
-
Methods inherited from interface io.vavr.Value
collect, collect, corresponds, eq, exists, forAll, forEach, getOrElse, getOrElse, getOrElseThrow, getOrElseTry, getOrNull, 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, toVector
-
-
-
-
Method Detail
-
empty
public static <T> LinkedHashSet<T> empty()
-
collector
public static <T> java.util.stream.Collector<T,java.util.ArrayList<T>,LinkedHashSet<T>> collector()
Returns aCollector
which may be used in conjunction withStream.collect(Collector)
to obtain aLinkedHashSet
.- Type Parameters:
T
- Component type of the LinkedHashSet.- Returns:
- A io.vavr.collection.LinkedHashSet Collector.
-
narrow
public static <T> LinkedHashSet<T> narrow(LinkedHashSet<? extends T> linkedHashSet)
Narrows a widenedLinkedHashSet<? extends T>
toLinkedHashSet<T>
by performing a type-safe cast. This is eligible because immutable/read-only collections are covariant.- Type Parameters:
T
- Component type of thelinkedHashSet
.- Parameters:
linkedHashSet
- ALinkedHashSet
.- Returns:
- the given
linkedHashSet
instance as narrowed typeLinkedHashSet<T>
.
-
of
public static <T> LinkedHashSet<T> of(T element)
Returns a singletonLinkedHashSet
, i.e. aLinkedHashSet
of one element.- Type Parameters:
T
- The component type- Parameters:
element
- An element.- Returns:
- A new LinkedHashSet instance containing the given element
-
of
@SafeVarargs public static <T> LinkedHashSet<T> of(T... elements)
Creates a LinkedHashSet of the given elements.LinkedHashSet.of(1, 2, 3, 4)
- Type Parameters:
T
- Component type of the LinkedHashSet.- Parameters:
elements
- Zero or more elements.- Returns:
- A set containing the given elements.
- Throws:
java.lang.NullPointerException
- ifelements
is null
-
tabulate
public static <T> LinkedHashSet<T> tabulate(int n, java.util.function.Function<? super java.lang.Integer,? extends T> f)
Returns a LinkedHashSet containingn
values of a given Functionf
over a range of integer values from 0 ton - 1
.- Type Parameters:
T
- Component type of the LinkedHashSet- Parameters:
n
- The number of elements in the LinkedHashSetf
- The Function computing element values- Returns:
- A LinkedHashSet consisting of elements
f(0),f(1), ..., f(n - 1)
- Throws:
java.lang.NullPointerException
- iff
is null
-
fill
public static <T> LinkedHashSet<T> fill(int n, java.util.function.Supplier<? extends T> s)
Returns a LinkedHashSet containing tuples returned byn
calls to a given Suppliers
.- Type Parameters:
T
- Component type of the LinkedHashSet- Parameters:
n
- The number of elements in the LinkedHashSets
- The Supplier computing element values- Returns:
- A LinkedHashSet of size
n
, where each element contains the result supplied bys
. - Throws:
java.lang.NullPointerException
- ifs
is null
-
ofAll
public static <T> LinkedHashSet<T> ofAll(java.lang.Iterable<? extends T> elements)
Creates a LinkedHashSet of the given elements.- Type Parameters:
T
- The value type- Parameters:
elements
- Set elements- Returns:
- A new LinkedHashSet containing the given entries
-
ofAll
public static <T> LinkedHashSet<T> ofAll(java.util.stream.Stream<? extends T> javaStream)
Creates a LinkedHashSet that contains the elements of the givenStream
.- Type Parameters:
T
- Component type of the Stream.- Parameters:
javaStream
- AStream
- Returns:
- A LinkedHashSet containing the given elements in the same order.
-
ofAll
public static LinkedHashSet<java.lang.Boolean> ofAll(boolean... elements)
Creates a LinkedHashSet from boolean values.- Parameters:
elements
- boolean values- Returns:
- A new LinkedHashSet of Boolean values
- Throws:
java.lang.NullPointerException
- if elements is null
-
ofAll
public static LinkedHashSet<java.lang.Byte> ofAll(byte... elements)
Creates a LinkedHashSet from byte values.- Parameters:
elements
- byte values- Returns:
- A new LinkedHashSet of Byte values
- Throws:
java.lang.NullPointerException
- if elements is null
-
ofAll
public static LinkedHashSet<java.lang.Character> ofAll(char... elements)
Creates a LinkedHashSet from char values.- Parameters:
elements
- char values- Returns:
- A new LinkedHashSet of Character values
- Throws:
java.lang.NullPointerException
- if elements is null
-
ofAll
public static LinkedHashSet<java.lang.Double> ofAll(double... elements)
Creates a LinkedHashSet from double values.- Parameters:
elements
- double values- Returns:
- A new LinkedHashSet of Double values
- Throws:
java.lang.NullPointerException
- if elements is null
-
ofAll
public static LinkedHashSet<java.lang.Float> ofAll(float... elements)
Creates a LinkedHashSet from float values.- Parameters:
elements
- a float values- Returns:
- A new LinkedHashSet of Float values
- Throws:
java.lang.NullPointerException
- if elements is null
-
ofAll
public static LinkedHashSet<java.lang.Integer> ofAll(int... elements)
Creates a LinkedHashSet from int values.- Parameters:
elements
- int values- Returns:
- A new LinkedHashSet of Integer values
- Throws:
java.lang.NullPointerException
- if elements is null
-
ofAll
public static LinkedHashSet<java.lang.Long> ofAll(long... elements)
Creates a LinkedHashSet from long values.- Parameters:
elements
- long values- Returns:
- A new LinkedHashSet of Long values
- Throws:
java.lang.NullPointerException
- if elements is null
-
ofAll
public static LinkedHashSet<java.lang.Short> ofAll(short... elements)
Creates a LinkedHashSet from short values.- Parameters:
elements
- short values- Returns:
- A new LinkedHashSet of Short values
- Throws:
java.lang.NullPointerException
- if elements is null
-
range
public static LinkedHashSet<java.lang.Integer> range(int from, int toExclusive)
Creates a LinkedHashSet of int numbers starting fromfrom
, extending totoExclusive - 1
.Examples:
LinkedHashSet.range(0, 0) // = LinkedHashSet() LinkedHashSet.range(2, 0) // = LinkedHashSet() LinkedHashSet.range(-2, 2) // = LinkedHashSet(-2, -1, 0, 1)
- Parameters:
from
- the first numbertoExclusive
- the last number + 1- Returns:
- a range of int values as specified or the empty range if
from >= toExclusive
-
range
public static LinkedHashSet<java.lang.Character> range(char from, char toExclusive)
-
rangeBy
public static LinkedHashSet<java.lang.Integer> rangeBy(int from, int toExclusive, int step)
Creates a LinkedHashSet of int numbers starting fromfrom
, extending totoExclusive - 1
, withstep
.Examples:
LinkedHashSet.rangeBy(1, 3, 1) // = LinkedHashSet(1, 2) LinkedHashSet.rangeBy(1, 4, 2) // = LinkedHashSet(1, 3) LinkedHashSet.rangeBy(4, 1, -2) // = LinkedHashSet(4, 2) LinkedHashSet.rangeBy(4, 1, 2) // = LinkedHashSet()
- Parameters:
from
- the first numbertoExclusive
- the last number + 1step
- the step- Returns:
- a range of long values as specified or the empty range if
from >= toInclusive
andstep > 0
or
from <= toInclusive
andstep < 0
- Throws:
java.lang.IllegalArgumentException
- ifstep
is zero
-
rangeBy
public static LinkedHashSet<java.lang.Character> rangeBy(char from, char toExclusive, int step)
-
rangeBy
@GwtIncompatible public static LinkedHashSet<java.lang.Double> rangeBy(double from, double toExclusive, double step)
-
range
public static LinkedHashSet<java.lang.Long> range(long from, long toExclusive)
Creates a LinkedHashSet of long numbers starting fromfrom
, extending totoExclusive - 1
.Examples:
LinkedHashSet.range(0L, 0L) // = LinkedHashSet() LinkedHashSet.range(2L, 0L) // = LinkedHashSet() LinkedHashSet.range(-2L, 2L) // = LinkedHashSet(-2L, -1L, 0L, 1L)
- Parameters:
from
- the first numbertoExclusive
- the last number + 1- Returns:
- a range of long values as specified or the empty range if
from >= toExclusive
-
rangeBy
public static LinkedHashSet<java.lang.Long> rangeBy(long from, long toExclusive, long step)
Creates a LinkedHashSet of long numbers starting fromfrom
, extending totoExclusive - 1
, withstep
.Examples:
LinkedHashSet.rangeBy(1L, 3L, 1L) // = LinkedHashSet(1L, 2L) LinkedHashSet.rangeBy(1L, 4L, 2L) // = LinkedHashSet(1L, 3L) LinkedHashSet.rangeBy(4L, 1L, -2L) // = LinkedHashSet(4L, 2L) LinkedHashSet.rangeBy(4L, 1L, 2L) // = LinkedHashSet()
- Parameters:
from
- the first numbertoExclusive
- the last number + 1step
- the step- Returns:
- a range of long values as specified or the empty range if
from >= toInclusive
andstep > 0
or
from <= toInclusive
andstep < 0
- Throws:
java.lang.IllegalArgumentException
- ifstep
is zero
-
rangeClosed
public static LinkedHashSet<java.lang.Integer> rangeClosed(int from, int toInclusive)
Creates a LinkedHashSet of int numbers starting fromfrom
, extending totoInclusive
.Examples:
LinkedHashSet.rangeClosed(0, 0) // = LinkedHashSet(0) LinkedHashSet.rangeClosed(2, 0) // = LinkedHashSet() LinkedHashSet.rangeClosed(-2, 2) // = LinkedHashSet(-2, -1, 0, 1, 2)
- Parameters:
from
- the first numbertoInclusive
- the last number- Returns:
- a range of int values as specified or the empty range if
from > toInclusive
-
rangeClosed
public static LinkedHashSet<java.lang.Character> rangeClosed(char from, char toInclusive)
-
rangeClosedBy
public static LinkedHashSet<java.lang.Integer> rangeClosedBy(int from, int toInclusive, int step)
Creates a LinkedHashSet of int numbers starting fromfrom
, extending totoInclusive
, withstep
.Examples:
LinkedHashSet.rangeClosedBy(1, 3, 1) // = LinkedHashSet(1, 2, 3) LinkedHashSet.rangeClosedBy(1, 4, 2) // = LinkedHashSet(1, 3) LinkedHashSet.rangeClosedBy(4, 1, -2) // = LinkedHashSet(4, 2) LinkedHashSet.rangeClosedBy(4, 1, 2) // = LinkedHashSet()
- Parameters:
from
- the first numbertoInclusive
- the last numberstep
- the step- Returns:
- a range of int values as specified or the empty range if
from > toInclusive
andstep > 0
or
from < toInclusive
andstep < 0
- Throws:
java.lang.IllegalArgumentException
- ifstep
is zero
-
rangeClosedBy
public static LinkedHashSet<java.lang.Character> rangeClosedBy(char from, char toInclusive, int step)
-
rangeClosedBy
@GwtIncompatible public static LinkedHashSet<java.lang.Double> rangeClosedBy(double from, double toInclusive, double step)
-
rangeClosed
public static LinkedHashSet<java.lang.Long> rangeClosed(long from, long toInclusive)
Creates a LinkedHashSet of long numbers starting fromfrom
, extending totoInclusive
.Examples:
LinkedHashSet.rangeClosed(0L, 0L) // = LinkedHashSet(0L) LinkedHashSet.rangeClosed(2L, 0L) // = LinkedHashSet() LinkedHashSet.rangeClosed(-2L, 2L) // = LinkedHashSet(-2L, -1L, 0L, 1L, 2L)
- Parameters:
from
- the first numbertoInclusive
- the last number- Returns:
- a range of long values as specified or the empty range if
from > toInclusive
-
rangeClosedBy
public static LinkedHashSet<java.lang.Long> rangeClosedBy(long from, long toInclusive, long step)
Creates a LinkedHashSet of long numbers starting fromfrom
, extending totoInclusive
, withstep
.Examples:
LinkedHashSet.rangeClosedBy(1L, 3L, 1L) // = LinkedHashSet(1L, 2L, 3L) LinkedHashSet.rangeClosedBy(1L, 4L, 2L) // = LinkedHashSet(1L, 3L) LinkedHashSet.rangeClosedBy(4L, 1L, -2L) // = LinkedHashSet(4L, 2L) LinkedHashSet.rangeClosedBy(4L, 1L, 2L) // = LinkedHashSet()
- Parameters:
from
- the first numbertoInclusive
- the last numberstep
- the step- Returns:
- a range of int values as specified or the empty range if
from > toInclusive
andstep > 0
or
from < toInclusive
andstep < 0
- Throws:
java.lang.IllegalArgumentException
- ifstep
is zero
-
add
public LinkedHashSet<T> add(T element)
Add the given element to this set, replacing existing one if it is already contained.Note that this method has a worst-case linear complexity.
-
addAll
public LinkedHashSet<T> addAll(java.lang.Iterable<? extends T> elements)
Adds all of the given elements to this set, replacing existing one if they are not already contained.Note that this method has a worst-case quadratic complexity.
-
collect
public <R> LinkedHashSet<R> collect(PartialFunction<? super T,? extends R> partialFunction)
Description copied from interface:Traversable
Collects all elements that are in the domain of the givenpartialFunction
by mapping the elements to typeR
.More specifically, for each of this elements in iteration order first it is checked
If the elements makes it through that filter, the mapped instance is added to the result collectionpartialFunction.isDefinedAt(element)
Note:If thisR newElement = partialFunction.apply(element)
Traversable
is ordered (i.e. extendsOrdered
, the caller ofcollect
has to ensure that the elements are comparable (i.e. extendComparable
).- Specified by:
collect
in interfaceSet<T>
- Specified by:
collect
in interfaceTraversable<T>
- Type Parameters:
R
- The new element type- Parameters:
partialFunction
- A function that is not necessarily defined of all elements of this traversable.- Returns:
- A new
Traversable
instance containing elements of typeR
-
contains
public boolean contains(T element)
Description copied from interface:Value
Shortcut forexists(e -> Objects.equals(e, element))
, tests if the givenelement
is contained.
-
diff
public LinkedHashSet<T> diff(Set<? extends T> elements)
Description copied from interface:Set
Calculates the difference between this set and another set.See also
Set.removeAll(Iterable)
.
-
distinct
public LinkedHashSet<T> distinct()
Description copied from interface:Traversable
Returns a new version of this which contains no duplicates. Elements are compared usingequals
.
-
distinctBy
public LinkedHashSet<T> distinctBy(java.util.Comparator<? super T> comparator)
Description copied from interface:Traversable
Returns a new version of this which contains no duplicates. Elements are compared using the givencomparator
.- Specified by:
distinctBy
in interfaceSet<T>
- Specified by:
distinctBy
in interfaceTraversable<T>
- Parameters:
comparator
- A comparator- Returns:
- a new
Traversable
containing this elements without duplicates
-
distinctBy
public <U> LinkedHashSet<T> distinctBy(java.util.function.Function<? super T,? extends U> keyExtractor)
Description copied from interface:Traversable
Returns a new version of this which contains no duplicates. Elements mapped to keys which are compared usingequals
.The elements of the result are determined in the order of their occurrence - first match wins.
- Specified by:
distinctBy
in interfaceSet<T>
- Specified by:
distinctBy
in interfaceTraversable<T>
- Type Parameters:
U
- key type- Parameters:
keyExtractor
- A key extractor- Returns:
- a new
Traversable
containing this elements without duplicates
-
drop
public LinkedHashSet<T> drop(int n)
Description copied from interface:Traversable
Drops the first n elements of this or all elements, if this length < n.
-
dropRight
public LinkedHashSet<T> dropRight(int n)
Description copied from interface:Traversable
Drops the last n elements of this or all elements, if this length < n.
-
dropUntil
public LinkedHashSet<T> dropUntil(java.util.function.Predicate<? super T> predicate)
Description copied from interface:Traversable
Drops elements until the predicate holds for the current element.
-
dropWhile
public LinkedHashSet<T> dropWhile(java.util.function.Predicate<? super T> predicate)
Description copied from interface:Traversable
Drops elements while the predicate holds for the current element.Note: This is essentially the same as
dropUntil(predicate.negate())
. It is intended to be used with method references, which cannot be negated directly.
-
filter
public LinkedHashSet<T> filter(java.util.function.Predicate<? super T> predicate)
Description copied from interface:Traversable
Returns a new traversable consisting of all elements which satisfy the given predicate.
-
filterNot
public LinkedHashSet<T> filterNot(java.util.function.Predicate<? super T> predicate)
Description copied from interface:Traversable
Returns a new traversable consisting of all elements which do not satisfy the given predicate.The default implementation is equivalent to
filter(predicate.negate()
-
reject
@Deprecated public LinkedHashSet<T> reject(java.util.function.Predicate<? super T> predicate)
Deprecated.Description copied from interface:Traversable
Returns a new traversable consisting of all elements which do not satisfy the given predicate.The default implementation is equivalent to
filter(predicate.negate()
-
flatMap
public <U> LinkedHashSet<U> flatMap(java.util.function.Function<? super T,? extends java.lang.Iterable<? extends U>> mapper)
Description copied from interface:Traversable
FlatMaps this Traversable.
-
foldRight
public <U> U foldRight(U zero, java.util.function.BiFunction<? super T,? super U,? extends U> f)
Description copied from interface:Traversable
Folds this elements from the right, starting withzero
and successively callingcombine
.Example:
// = "!cba" List("a", "b", "c").foldRight("!", (x, xs) -> xs + x)
-
groupBy
public <C> Map<C,LinkedHashSet<T>> groupBy(java.util.function.Function<? super T,? extends C> classifier)
Description copied from interface:Traversable
Groups this elements by classifying the elements.- Specified by:
groupBy
in interfaceSet<T>
- Specified by:
groupBy
in interfaceTraversable<T>
- Type Parameters:
C
- classified class type- Parameters:
classifier
- A function which classifies elements into classes- Returns:
- A Map containing the grouped elements
- See Also:
Traversable.arrangeBy(Function)
-
grouped
public Iterator<LinkedHashSet<T>> grouped(int size)
Description copied from interface:Traversable
Groups thisTraversable
into fixed size blocks.Let length be the length of this Iterable. Then grouped is defined as follows:
- If
this.isEmpty()
, the resultingIterator
is empty. - If
size <= length
, the resultingIterator
will containlength / size
blocks of sizesize
and maybe a non-empty block of sizelength % size
, if there are remaining elements. - If
size > length
, the resultingIterator
will contain one block of sizelength
.
[].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]]
grouped(int)
is a special case of Traversable.sliding(int, int), i.e.grouped(size)
is the same assliding(size, size)
. - If
-
hasDefiniteSize
public boolean hasDefiniteSize()
Description copied from interface:Traversable
Checks if this Traversable is known to have a finite size.This method should be implemented by classes only, i.e. not by interfaces.
- Specified by:
hasDefiniteSize
in interfaceTraversable<T>
- Returns:
- true, if this Traversable is known to have a finite size, false otherwise.
-
head
public T head()
Description copied from interface:Traversable
Returns the first element of a non-empty Traversable.- Specified by:
head
in interfaceTraversable<T>
- Returns:
- The first element of this Traversable.
-
headOption
public Option<T> headOption()
Description copied from interface:Traversable
Returns the first element of a non-empty Traversable asOption
.- Specified by:
headOption
in interfaceTraversable<T>
- Returns:
Some(element)
orNone
if this is empty.
-
init
public LinkedHashSet<T> init()
Description copied from interface:Traversable
Dual of Traversable.tail(), returning all elements except the last.
-
initOption
public Option<LinkedHashSet<T>> initOption()
Description copied from interface:Traversable
Dual of Traversable.tailOption(), returning all elements except the last asOption
.- Specified by:
initOption
in interfaceSet<T>
- Specified by:
initOption
in interfaceTraversable<T>
- Returns:
Some(traversable)
orNone
if this is empty.
-
intersect
public LinkedHashSet<T> intersect(Set<? extends T> elements)
Description copied from interface:Set
Computes the intersection between this set and another set.See also
Set.retainAll(Iterable)
.
-
isAsync
public boolean isAsync()
AnLinkedHashSet
's value is computed synchronously.
-
isEmpty
public boolean isEmpty()
Description copied from interface:Traversable
Checks if this Traversable is empty.
-
isLazy
public boolean isLazy()
AnLinkedHashSet
's value is computed eagerly.
-
isTraversableAgain
public boolean isTraversableAgain()
Description copied from interface:Traversable
Checks if this Traversable can be repeatedly traversed.This method should be implemented by classes only, i.e. not by interfaces.
- Specified by:
isTraversableAgain
in interfaceTraversable<T>
- Returns:
- true, if this Traversable is known to be traversable repeatedly, false otherwise.
-
isSequential
public boolean isSequential()
Description copied from interface:Traversable
Checks if the elements of this Traversable appear in encounter order.- Specified by:
isSequential
in interfaceTraversable<T>
- Returns:
- true, if the insertion order of elements is preserved, false otherwise.
-
iterator
public Iterator<T> iterator()
Description copied from interface:Traversable
An iterator by means of head() and tail(). Subclasses may want to override this method.
-
last
public T last()
Description copied from interface:Traversable
Dual of Traversable.head(), returning the last element.- Specified by:
last
in interfaceTraversable<T>
- Returns:
- the last element.
-
length
public int length()
Description copied from interface:Traversable
Computes the number of elements of this Traversable.Same as
Traversable.size()
.
-
map
public <U> LinkedHashSet<U> map(java.util.function.Function<? super T,? extends U> mapper)
Description copied from interface:Traversable
Maps the elements of thisTraversable
to elements of a new type preserving their order, if any.
-
mkString
public java.lang.String mkString(java.lang.CharSequence prefix, java.lang.CharSequence delimiter, java.lang.CharSequence suffix)
Description copied from interface:Traversable
Joins the string representations of this elements using a specific delimiter, prefix and suffix.Example:
List.of("a", "b", "c").mkString("Chars(", ", ", ")") = "Chars(a, b, c)"
- Specified by:
mkString
in interfaceTraversable<T>
- Parameters:
prefix
- prefix of the resulting stringdelimiter
- A delimiter string put between string representations of elements of thissuffix
- suffix of the resulting string- Returns:
- a new String
-
orElse
public LinkedHashSet<T> orElse(java.lang.Iterable<? extends T> other)
Description copied from interface:Traversable
Returns thisTraversable
if it is nonempty, otherwise return the alternative.
-
orElse
public LinkedHashSet<T> orElse(java.util.function.Supplier<? extends java.lang.Iterable<? extends T>> supplier)
Description copied from interface:Traversable
Returns thisTraversable
if it is nonempty, otherwise return the result of evaluating supplier.
-
partition
public Tuple2<LinkedHashSet<T>,LinkedHashSet<T>> partition(java.util.function.Predicate<? super T> predicate)
Description copied from interface:Traversable
Creates a partition of thisTraversable
by splitting this elements in two in distinct traversables according to a predicate.- Specified by:
partition
in interfaceSet<T>
- Specified by:
partition
in interfaceTraversable<T>
- Parameters:
predicate
- A predicate which classifies an element if it is in the first or the second traversable.- Returns:
- A disjoint union of two traversables. The first
Traversable
contains all elements that satisfy the givenpredicate
, the secondTraversable
contains all elements that don't. The original order of elements is preserved.
-
peek
public LinkedHashSet<T> peek(java.util.function.Consumer<? super T> action)
Description copied from interface:Value
Performs the givenaction
on the first element if this is an eager implementation. Performs the givenaction
on all elements (the first immediately, successive deferred), if this is a lazy implementation.
-
remove
public LinkedHashSet<T> remove(T element)
Description copied from interface:Set
Removes a specific element from this set, if present.
-
removeAll
public LinkedHashSet<T> removeAll(java.lang.Iterable<? extends T> elements)
Description copied from interface:Set
Removes all of the given elements from this set, if present.
-
replace
public LinkedHashSet<T> replace(T currentElement, T newElement)
Description copied from interface:Traversable
Replaces the first occurrence (if exists) of the given currentElement with newElement.- Specified by:
replace
in interfaceSet<T>
- Specified by:
replace
in interfaceTraversable<T>
- Parameters:
currentElement
- An element to be substituted.newElement
- A replacement for currentElement.- Returns:
- a Traversable containing all elements of this where the first occurrence of currentElement is replaced with newElement.
-
replaceAll
public LinkedHashSet<T> replaceAll(T currentElement, T newElement)
Description copied from interface:Traversable
Replaces all occurrences of the given currentElement with newElement.- Specified by:
replaceAll
in interfaceSet<T>
- Specified by:
replaceAll
in interfaceTraversable<T>
- Parameters:
currentElement
- An element to be substituted.newElement
- A replacement for currentElement.- Returns:
- a Traversable containing all elements of this where all occurrences of currentElement are replaced with newElement.
-
retainAll
public LinkedHashSet<T> retainAll(java.lang.Iterable<? extends T> elements)
Description copied from interface:Traversable
Keeps all occurrences of the given elements from this.
-
scan
public LinkedHashSet<T> scan(T zero, java.util.function.BiFunction<? super T,? super T,? extends T> operation)
Description copied from interface:Traversable
Computes a prefix scan of the elements of the collection. Note: The neutral element z may be applied more than once.- Specified by:
scan
in interfaceSet<T>
- Specified by:
scan
in interfaceTraversable<T>
- Parameters:
zero
- neutral element for the operator opoperation
- the associative operator for the scan- Returns:
- a new traversable collection containing the prefix scan of the elements in this traversable collection
-
scanLeft
public <U> LinkedHashSet<U> scanLeft(U zero, java.util.function.BiFunction<? super U,? super T,? extends U> operation)
Description copied from interface:Traversable
Produces a collection containing cumulative results of applying the operator going left to right. Note: will not terminate for infinite-sized collections. Note: might return different results for different runs, unless the underlying collection type is ordered.- Specified by:
scanLeft
in interfaceSet<T>
- Specified by:
scanLeft
in interfaceTraversable<T>
- Type Parameters:
U
- the type of the elements in the resulting collection- Parameters:
zero
- the initial valueoperation
- the binary operator applied to the intermediate result and the element- Returns:
- collection with intermediate results
-
scanRight
public <U> LinkedHashSet<U> scanRight(U zero, java.util.function.BiFunction<? super T,? super U,? extends U> operation)
Description copied from interface:Traversable
Produces a collection containing cumulative results of applying the operator going right to left. The head of the collection is the last cumulative result. Note: will not terminate for infinite-sized collections. Note: might return different results for different runs, unless the underlying collection type is ordered.- Specified by:
scanRight
in interfaceSet<T>
- Specified by:
scanRight
in interfaceTraversable<T>
- Type Parameters:
U
- the type of the elements in the resulting collection- Parameters:
zero
- the initial valueoperation
- the binary operator applied to the intermediate result and the element- Returns:
- collection with intermediate results
-
slideBy
public Iterator<LinkedHashSet<T>> slideBy(java.util.function.Function<? super T,?> classifier)
Description copied from interface:Traversable
Slides a non-overlapping window of a variable size over thisTraversable
.Each window contains elements with the same class, as determined by
classifier
. Two consecutive values in thisTraversable
will be in the same window only ifclassifier
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]]
-
sliding
public Iterator<LinkedHashSet<T>> sliding(int size)
Description copied from interface:Traversable
Slides a window of a specificsize
and step size 1 over thisTraversable
by callingTraversable.sliding(int, int)
.
-
sliding
public Iterator<LinkedHashSet<T>> sliding(int size, int step)
Description copied from interface:Traversable
Slides a window of a specificsize
andstep
size over thisTraversable
.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],[4]]
-
span
public Tuple2<LinkedHashSet<T>,LinkedHashSet<T>> span(java.util.function.Predicate<? super T> predicate)
Description copied from interface:Traversable
Returns a tuple where the first element is the longest prefix of elements that satisfy the givenpredicate
and the second element is the remainder.
-
tail
public LinkedHashSet<T> tail()
Description copied from interface:Traversable
Drops the first element of a non-empty Traversable.
-
tailOption
public Option<LinkedHashSet<T>> tailOption()
Description copied from interface:Traversable
Drops the first element of a non-empty Traversable and returns anOption
.- Specified by:
tailOption
in interfaceSet<T>
- Specified by:
tailOption
in interfaceTraversable<T>
- Returns:
Some(traversable)
orNone
if this is empty.
-
take
public LinkedHashSet<T> take(int n)
Description copied from interface:Traversable
Takes the first n elements of this or all elements, if this length < n.The result is equivalent to
sublist(0, max(0, min(length(), n)))
but does not throw ifn < 0
orn > length()
.In the case of
n < 0
the empty instance is returned, in the case ofn > length()
this is returned.
-
takeRight
public LinkedHashSet<T> takeRight(int n)
Description copied from interface:Traversable
Takes the last n elements of this or all elements, if this length < n.The result is equivalent to
sublist(max(0, min(length(), length() - n)), n)
, i.e. takeRight will not throw ifn < 0
orn > length()
.In the case of
n < 0
the empty instance is returned, in the case ofn > length()
this is returned.
-
takeUntil
public LinkedHashSet<T> takeUntil(java.util.function.Predicate<? super T> predicate)
Description copied from interface:Traversable
Takes elements until the predicate holds for the current element.Note: This is essentially the same as
takeWhile(predicate.negate())
. It is intended to be used with method references, which cannot be negated directly.
-
takeWhile
public LinkedHashSet<T> takeWhile(java.util.function.Predicate<? super T> predicate)
Description copied from interface:Traversable
Takes elements while the predicate holds for the current element.
-
transform
public <U> U transform(java.util.function.Function<? super LinkedHashSet<T>,? extends U> f)
Transforms thisLinkedHashSet
.- Type Parameters:
U
- Type of transformation result- Parameters:
f
- A transformation- Returns:
- An instance of type
U
- Throws:
java.lang.NullPointerException
- iff
is null
-
toJavaSet
public java.util.LinkedHashSet<T> toJavaSet()
Description copied from interface:Set
Converts this VavrSet
to ajava.util.Set
while preserving characteristics like insertion order (LinkedHashSet
) and sort order (SortedSet
).
-
union
public LinkedHashSet<T> union(Set<? extends T> elements)
Adds all of the elements ofelements
to this set, replacing existing ones if they already present.Note that this method has a worst-case quadratic complexity.
See also
addAll(Iterable)
.
-
unzip
public <T1,T2> Tuple2<LinkedHashSet<T1>,LinkedHashSet<T2>> unzip(java.util.function.Function<? super T,Tuple2<? extends T1,? extends T2>> unzipper)
Description copied from interface:Traversable
Unzips this elements by mapping this elements to pairs which are subsequently split into two distinct sets.- Specified by:
unzip
in interfaceSet<T>
- Specified by:
unzip
in interfaceTraversable<T>
- Type Parameters:
T1
- 1st element type of a pair returned by unzipperT2
- 2nd element type of a pair returned by unzipper- Parameters:
unzipper
- a function which converts elements of this to pairs- Returns:
- A pair of set containing elements split by unzipper
-
unzip3
public <T1,T2,T3> Tuple3<LinkedHashSet<T1>,LinkedHashSet<T2>,LinkedHashSet<T3>> unzip3(java.util.function.Function<? super T,Tuple3<? extends T1,? extends T2,? extends T3>> unzipper)
Description copied from interface:Traversable
Unzips this elements by mapping this elements to triples which are subsequently split into three distinct sets.- Specified by:
unzip3
in interfaceSet<T>
- Specified by:
unzip3
in interfaceTraversable<T>
- Type Parameters:
T1
- 1st element type of a triplet returned by unzipperT2
- 2nd element type of a triplet returned by unzipperT3
- 3rd element type of a triplet returned by unzipper- Parameters:
unzipper
- a function which converts elements of this to pairs- Returns:
- A triplet of set containing elements split by unzipper
-
zip
public <U> LinkedHashSet<Tuple2<T,U>> zip(java.lang.Iterable<? extends U> that)
Description copied from interface:Traversable
Returns a traversable formed from this traversable and another Iterable collection by combining corresponding elements in pairs. If one of the two iterables is longer than the other, its remaining elements are ignored.The length of the returned traversable is the minimum of the lengths of this traversable and
that
iterable.- Specified by:
zip
in interfaceSet<T>
- Specified by:
zip
in interfaceTraversable<T>
- Type Parameters:
U
- The type of the second half of the returned pairs.- Parameters:
that
- The Iterable providing the second half of each result pair.- Returns:
- a new traversable containing pairs consisting of corresponding elements of this traversable and
that
iterable.
-
zipWith
public <U,R> LinkedHashSet<R> zipWith(java.lang.Iterable<? extends U> that, java.util.function.BiFunction<? super T,? super U,? extends R> mapper)
Description copied from interface:Traversable
Returns a traversable formed from this traversable and another Iterable collection by mapping elements. If one of the two iterables is longer than the other, its remaining elements are ignored.The length of the returned traversable is the minimum of the lengths of this traversable and
that
iterable.- Specified by:
zipWith
in interfaceSet<T>
- Specified by:
zipWith
in interfaceTraversable<T>
- Type Parameters:
U
- The type of the second parameter of the mapper.R
- The type of the mapped elements.- Parameters:
that
- The Iterable providing the second parameter of the mapper.mapper
- a mapper.- Returns:
- a new traversable containing mapped elements of this traversable and
that
iterable.
-
zipAll
public <U> LinkedHashSet<Tuple2<T,U>> zipAll(java.lang.Iterable<? extends U> that, T thisElem, U thatElem)
Description copied from interface:Traversable
Returns a traversable formed from this traversable and another Iterable by combining corresponding elements in pairs. If one of the two collections is shorter than the other, placeholder elements are used to extend the shorter collection to the length of the longer.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.
- Specified by:
zipAll
in interfaceSet<T>
- Specified by:
zipAll
in interfaceTraversable<T>
- Type Parameters:
U
- The type of the second half of the returned pairs.- Parameters:
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.- Returns:
- A new traversable containing pairs consisting of corresponding elements of this traversable and that.
-
zipWithIndex
public LinkedHashSet<Tuple2<T,java.lang.Integer>> zipWithIndex()
Description copied from interface:Traversable
Zips this traversable with its indices.- Specified by:
zipWithIndex
in interfaceSet<T>
- Specified by:
zipWithIndex
in interfaceTraversable<T>
- Returns:
- A new traversable containing all elements of this traversable paired with their index, starting with 0.
-
zipWithIndex
public <U> LinkedHashSet<U> zipWithIndex(java.util.function.BiFunction<? super T,? super java.lang.Integer,? extends U> mapper)
Description copied from interface:Traversable
Returns a traversable formed from this traversable and another Iterable collection by mapping elements. If one of the two iterables is longer than the other, its remaining elements are ignored.The length of the returned traversable is the minimum of the lengths of this traversable and
that
iterable.- Specified by:
zipWithIndex
in interfaceSet<T>
- Specified by:
zipWithIndex
in interfaceTraversable<T>
- Type Parameters:
U
- The type of the mapped elements.- Parameters:
mapper
- a mapper.- Returns:
- a new traversable containing mapped elements of this traversable and
that
iterable.
-
equals
public boolean equals(java.lang.Object o)
Description copied from interface:Traversable
In Vavr there are four basic classes of collections:- Seq (sequential elements)
- Set (distinct elements)
- Map (indexed elements)
- Multimap (indexed 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
Notes:
- No collection instance equals null, e.g. Queue(1) not equals null.
- Nulls are allowed and handled as expected, e.g. List(null, 1) equals Stream(null, 1) and HashMap((null, 1)) equals LinkedHashMap((null, 1)).
- The element order is taken into account for Seq only. E.g. List(null, 1) not equals Stream(1, null) and HashMap((null, 1), ("a", null)) equals LinkedHashMap(("a", null), (null, 1)). The reason is, that we do not know which implementations we compare when having two instances of type Map, Multimap or Set (see Liskov Substitution Principle).
- Other collection classes are equal if their types are equal and their elements are equal (in iteration order).
- Iterator equality is defined to be object reference equality.
-
hashCode
public int hashCode()
Description copied from interface:Traversable
Returns the hash code of this collection.
We distinguish between two types of hashes, those for collections with predictable iteration order (like Seq) and those with arbitrary iteration order (like Set, Map and Multimap).
In all cases the hash of an empty collection is defined to be 1.
Collections with predictable iteration order are hashed as follows:
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 = hash * 31 + Objects.hashCode(t); }
Please note that the particular hashing algorithms may change in a future version of Vavr.int hash = 1; for (T t : this) { hash += Objects.hashCode(t); }
Generally, hash codes of collections aren't cached in Vavr (opposed to the size/length). Storing hash codes in order to reduce the time complexity would increase the memory footprint. Persistent collections are built upon tree structures, it allows us to implement efficient memory sharing. A drawback of tree structures is that they make it necessary to store collection attributes at each tree node (read: element).
The computation of the hash code is linear in time, i.e. O(n). If the hash code of a collection is re-calculated often, e.g. when using a List as HashMap key, we might want to cache the hash code. This can be achieved by simply using a wrapper class, which is not included in Vavr but could be implemented like this: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()) + ")"; } }
-
stringPrefix
public java.lang.String stringPrefix()
Description copied from interface:Value
Returns the name of this Value type, which is used by toString().- Specified by:
stringPrefix
in interfaceValue<T>
- Returns:
- This type name.
-
toString
public java.lang.String toString()
Description copied from interface:Value
Clarifies that values have a proper toString() method implemented.See Object.toString().
-
-