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>,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 immutableHashSetimplementation that has predictable (insertion-order) iteration.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description private static classLinkedHashSet.SerializationProxy<T>A serialization proxy which, in this context, is used to deserialize immutable, linked Lists with final instance fields.
-
Field Summary
Fields Modifier and Type Field Description private static LinkedHashSet<?>EMPTYprivate LinkedHashMap<T,java.lang.Object>mapprivate static longserialVersionUID
-
Constructor Summary
Constructors Modifier Constructor Description privateLinkedHashSet(LinkedHashMap<T,java.lang.Object> map)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods 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(@NonNull java.lang.Iterable<? extends T> elements)Adds all of the given elements to this set, replacing existing one if they are not already contained.private static <T> LinkedHashMap<T,java.lang.Object>addAll(LinkedHashMap<T,java.lang.Object> initial, java.lang.Iterable<? extends T> additional)<R> LinkedHashSet<R>collect(@NonNull PartialFunction<? super T,? extends R> partialFunction)Applies aPartialFunctionto all elements that are defined for it and collects the results.static <T> java.util.stream.Collector<T,java.util.ArrayList<T>,LinkedHashSet<T>>collector()Returns aCollectorwhich may be used in conjunction withStream.collect(Collector)to obtain aLinkedHashSet.booleancontains(T element)Shortcut forexists(e -> Objects.equals(e, element)), tests if the givenelementis contained.LinkedHashSet<T>diff(@NonNull Set<? extends T> elements)Returns a new set containing all elements of this set except those in the given set.LinkedHashSet<T>distinct()Returns a newTraversablecontaining the elements of this instance with all duplicates removed.LinkedHashSet<T>distinctBy(@NonNull java.util.Comparator<? super T> comparator)Returns a newTraversablecontaining the elements of this instance without duplicates, as determined by the givencomparator.<U> LinkedHashSet<T>distinctBy(@NonNull java.util.function.Function<? super T,? extends U> keyExtractor)Returns a newTraversablecontaining the elements of this instance without duplicates, based on keys extracted from elements usingkeyExtractor.LinkedHashSet<T>drop(int n)Returns a newTraversablewithout the firstnelements, or an empty instance if this contains fewer thannelements.LinkedHashSet<T>dropRight(int n)Returns a newTraversablewithout the lastnelements, or an empty instance if this contains fewer thannelements.LinkedHashSet<T>dropUntil(@NonNull java.util.function.Predicate<? super T> predicate)Returns a newTraversablestarting from the first element that satisfies the givenpredicate, dropping all preceding elements.LinkedHashSet<T>dropWhile(@NonNull java.util.function.Predicate<? super T> predicate)Returns a newTraversablestarting from the first element that does not satisfy the givenpredicate, dropping all preceding elements.static <T> LinkedHashSet<T>empty()Returns the empty LinkedHashSet.booleanequals(java.lang.Object o)Determines whether this collection is equal to the given object.static <T> LinkedHashSet<T>fill(int n, @NonNull java.util.function.Supplier<? extends T> s)Returns a LinkedHashSet containing tuples returned byncalls to a given Suppliers.LinkedHashSet<T>filter(@NonNull java.util.function.Predicate<? super T> predicate)Returns a new traversable containing only the elements that satisfy the given predicate.<U> LinkedHashSet<U>flatMap(@NonNull java.util.function.Function<? super T,? extends java.lang.Iterable<? extends U>> mapper)Transforms each element of this Traversable into anIterableof elements and flattens the resulting iterables into a single Traversable.<U> UfoldRight(U zero, @NonNull java.util.function.BiFunction<? super T,? super U,? extends U> f)Folds the elements of this structure from the right, starting with the givenzerovalue and successively applying thecombinefunction to each element.<C> Map<C,LinkedHashSet<T>>groupBy(@NonNull java.util.function.Function<? super T,? extends C> classifier)Groups elements of thisTraversablebased on a classifier function.Iterator<LinkedHashSet<T>>grouped(int size)Splits thisTraversableinto consecutive blocks of the given size.booleanhasDefiniteSize()Indicates whether thisTraversablehas a known finite size.inthashCode()Returns the hash code of this collection.Thead()Returns the first element of this non-emptyTraversable.Option<T>headOption()Returns the first element of thisTraversableas anOption.LinkedHashSet<T>init()Returns all elements of this Traversable except the last one.Option<LinkedHashSet<T>>initOption()Returns all elements of this Traversable except the last one, wrapped in anOption.LinkedHashSet<T>intersect(@NonNull Set<? extends T> elements)Returns a new set containing only the elements present in both this set and the given set.booleanisAsync()AnLinkedHashSet's value is computed synchronously.booleanisEmpty()Checks if this Traversable contains no elements.booleanisLazy()AnLinkedHashSet's value is computed eagerly.booleanisSequential()Indicates whether the elements of this Traversable appear in encounter (insertion) order.booleanisTraversableAgain()Checks if this Traversable can be traversed multiple times without side effects.@NonNull Iterator<T>iterator()Returns an iterator over the elements of this Traversable, implemented viaTraversable.head()andTraversable.tail().Tlast()Returns the last element of this Traversable.intlength()Returns the number of elements in this Traversable.<U> LinkedHashSet<U>map(@NonNull java.util.function.Function<? super T,? extends U> mapper)Transforms the elements of this Traversable to a new type, preserving order if defined.<U> LinkedHashSet<U>mapTo(U value)Maps the underlying value to another fixed value.LinkedHashSet<java.lang.Void>mapToVoid()Maps the underlying value to Voidjava.lang.StringmkString(java.lang.CharSequence prefix, java.lang.CharSequence delimiter, java.lang.CharSequence suffix)Concatenates the string representations of all elements in this Traversable with a prefix, delimiter, and suffix.static <T> LinkedHashSet<T>narrow(LinkedHashSet<? extends T> linkedHashSet)Narrows aLinkedHashSet<? extends T>toLinkedHashSet<T>via a type-safe cast.static <T> LinkedHashSet<T>of(T element)Returns a singletonLinkedHashSet, i.e.static <T> LinkedHashSet<T>of(T @NonNull ... elements)Creates a LinkedHashSet of the given elements.static LinkedHashSet<java.lang.Boolean>ofAll(boolean @NonNull ... elements)Creates a LinkedHashSet from boolean values.static LinkedHashSet<java.lang.Byte>ofAll(byte @NonNull ... elements)Creates a LinkedHashSet from byte values.static LinkedHashSet<java.lang.Character>ofAll(char @NonNull ... elements)Creates a LinkedHashSet from char values.static LinkedHashSet<java.lang.Double>ofAll(double @NonNull ... elements)Creates a LinkedHashSet from double values.static LinkedHashSet<java.lang.Float>ofAll(float @NonNull ... elements)Creates a LinkedHashSet from float values.static LinkedHashSet<java.lang.Integer>ofAll(int @NonNull ... elements)Creates a LinkedHashSet from int values.static LinkedHashSet<java.lang.Long>ofAll(long @NonNull ... elements)Creates a LinkedHashSet from long values.static LinkedHashSet<java.lang.Short>ofAll(short @NonNull ... elements)Creates a LinkedHashSet from short values.static <T> LinkedHashSet<T>ofAll(@NonNull java.lang.Iterable<? extends T> elements)Creates a LinkedHashSet of the given elements.static <T> LinkedHashSet<T>ofAll(@NonNull java.util.stream.Stream<? extends T> javaStream)Creates a LinkedHashSet that contains the elements of the givenStream.LinkedHashSet<T>orElse(@NonNull java.lang.Iterable<? extends T> other)Returns thisTraversableif it is non-empty; otherwise, returns the given alternative.LinkedHashSet<T>orElse(@NonNull java.util.function.Supplier<? extends java.lang.Iterable<? extends T>> supplier)Returns thisTraversableif it is non-empty; otherwise, returns the result of evaluating the given supplier.Tuple2<LinkedHashSet<T>,LinkedHashSet<T>>partition(@NonNull java.util.function.Predicate<? super T> predicate)Splits thisTraversableinto two partitions according to a predicate.LinkedHashSet<T>peek(@NonNull java.util.function.Consumer<? super T> action)Performs the givenactionon the first element if this is an eager implementation.static LinkedHashSet<java.lang.Character>range(char from, char toExclusive)Creates a LinkedHashSet of char numbers starting fromfrom, extending totoExclusive - 1.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)Creates a LinkedHashSet of char numbers starting fromfrom, extending totoExclusive - 1, withstep.static LinkedHashSet<java.lang.Double>rangeBy(double from, double toExclusive, double step)Creates a LinkedHashSet of double numbers starting fromfrom, extending totoExclusive - 1, withstep.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)Creates a LinkedHashSet of char numbers starting fromfrom, extending totoInclusive.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)Creates a LinkedHashSet of char numbers starting fromfrom, extending totoInclusive, withstep.static LinkedHashSet<java.lang.Double>rangeClosedBy(double from, double toInclusive, double step)Creates a LinkedHashSet of double numbers starting fromfrom, extending totoInclusive, withstep.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.private voidreadObject(java.io.ObjectInputStream stream)readObjectmethod for the serialization proxy pattern.LinkedHashSet<T>reject(@NonNull java.util.function.Predicate<? super T> predicate)Returns a new traversable containing only the elements that do not satisfy the given predicate.LinkedHashSet<T>remove(T element)Returns a new set with the given element removed, if it was present.LinkedHashSet<T>removeAll(@NonNull java.lang.Iterable<? extends T> elements)Returns a new set with all given elements removed, if present.LinkedHashSet<T>replace(T currentElement, T newElement)Replaces the first occurrence ofcurrentElementwithnewElement, if it exists.LinkedHashSet<T>replaceAll(T currentElement, T newElement)Replaces all occurrences ofcurrentElementwithnewElement.LinkedHashSet<T>retainAll(@NonNull java.lang.Iterable<? extends T> elements)Retains only the elements from this Traversable that are contained in the givenelements.LinkedHashSet<T>scan(T zero, @NonNull java.util.function.BiFunction<? super T,? super T,? extends T> operation)Computes a prefix scan of the elements of this Traversable.<U> LinkedHashSet<U>scanLeft(U zero, @NonNull java.util.function.BiFunction<? super U,? super T,? extends U> operation)Produces a collection containing cumulative results of applying the operator from left to right.<U> LinkedHashSet<U>scanRight(U zero, @NonNull java.util.function.BiFunction<? super T,? super U,? extends U> operation)Produces a collection containing cumulative results of applying the operator from right to left.Iterator<LinkedHashSet<T>>slideBy(@NonNull java.util.function.Function<? super T,?> classifier)Partitions thisTraversableinto consecutive non-overlapping windows according to a classification function.Iterator<LinkedHashSet<T>>sliding(int size)Slides a window of a givensizeover thisTraversablewith a step size of 1.Iterator<LinkedHashSet<T>>sliding(int size, int step)Slides a window of a specificsizewith a givenstepover thisTraversable.Tuple2<LinkedHashSet<T>,LinkedHashSet<T>>span(@NonNull java.util.function.Predicate<? super T> predicate)Splits thisTraversableinto a prefix and remainder according to the givenpredicate.java.lang.StringstringPrefix()Returns the name of this Value type, which is used by toString().static <T> LinkedHashSet<T>tabulate(int n, @NonNull java.util.function.Function<? super java.lang.Integer,? extends T> f)Returns a LinkedHashSet containingnvalues of a given Functionfover a range of integer values from 0 ton - 1.LinkedHashSet<T>tail()Returns a newTraversablewithout its first element.Option<LinkedHashSet<T>>tailOption()Returns a newTraversablewithout its first element as anOption.LinkedHashSet<T>take(int n)Returns the firstnelements of thisTraversable, or all elements ifnexceeds the length.LinkedHashSet<T>takeRight(int n)Returns the lastnelements of thisTraversable, or all elements ifnexceeds the length.LinkedHashSet<T>takeUntil(@NonNull java.util.function.Predicate<? super T> predicate)Takes elements from thisTraversableuntil the given predicate holds for an element.LinkedHashSet<T>takeWhile(@NonNull java.util.function.Predicate<? super T> predicate)Takes elements from thisTraversablewhile the given predicate holds.java.util.LinkedHashSet<T>toJavaSet()Converts this Vavr set to ajava.util.Set, preserving insertion or sort order.java.lang.StringtoString()Clarifies that values have a proper toString() method implemented.<U> Utransform(@NonNull java.util.function.Function<? super LinkedHashSet<T>,? extends U> f)Transforms thisLinkedHashSet.LinkedHashSet<T>union(@NonNull Set<? extends T> elements)Adds all of the elements ofelementsto this set, replacing existing ones if they already present.<T1,T2>
Tuple2<LinkedHashSet<T1>,LinkedHashSet<T2>>unzip(@NonNull java.util.function.Function<? super T,Tuple2<? extends T1,? extends T2>> unzipper)Unzips the elements of thisTraversableby mapping each element to a pair and splitting them into two separateTraversablecollections.<T1,T2,T3>
Tuple3<LinkedHashSet<T1>,LinkedHashSet<T2>,LinkedHashSet<T3>>unzip3(@NonNull java.util.function.Function<? super T,Tuple3<? extends T1,? extends T2,? extends T3>> unzipper)Unzips the elements of thisTraversableby mapping each element to a triple and splitting them into three separateTraversablecollections.(package private) static <T> LinkedHashSet<T>wrap(LinkedHashMap<T,java.lang.Object> map)private java.lang.ObjectwriteReplace()writeReplacemethod for the serialization proxy pattern.<U> LinkedHashSet<Tuple2<T,U>>zip(@NonNull java.lang.Iterable<? extends U> that)Returns aTraversableformed by pairing elements of thisTraversablewith elements of anotherIterable.<U> LinkedHashSet<Tuple2<T,U>>zipAll(@NonNull java.lang.Iterable<? extends U> that, T thisElem, U thatElem)Returns aTraversableformed by pairing elements of thisTraversablewith elements of anotherIterable, filling in placeholder elements when one collection is shorter than the other.<U,R>
LinkedHashSet<R>zipWith(@NonNull java.lang.Iterable<? extends U> that, @NonNull java.util.function.BiFunction<? super T,? super U,? extends R> mapper)Returns aTraversableby combining elements of thisTraversablewith elements of anotherIterableusing a mapping function.LinkedHashSet<Tuple2<T,java.lang.Integer>>zipWithIndex()Zips thisTraversablewith its indices, starting at 0.<U> LinkedHashSet<U>zipWithIndex(@NonNull java.util.function.BiFunction<? super T,? super java.lang.Integer,? extends U> mapper)Zips thisTraversablewith its indices and maps the resulting pairs using the provided mapper.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface io.vavr.collection.Foldable
fold, reduce, reduceOption
-
Methods inherited from interface io.vavr.Function1
andThen, arity, compose, compose1, 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, foldLeft, forEachWithIndex, get, isOrdered, isSingleValued, lastOption, max, maxBy, maxBy, min, minBy, minBy, mkCharSeq, mkCharSeq, mkCharSeq, mkString, mkString, nonEmpty, product, reduceLeft, reduceLeftOption, 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
-
-
-
-
Field Detail
-
serialVersionUID
private static final long serialVersionUID
- See Also:
- Constant Field Values
-
EMPTY
private static final LinkedHashSet<?> EMPTY
-
map
private final LinkedHashMap<T,java.lang.Object> map
-
-
Constructor Detail
-
LinkedHashSet
private LinkedHashSet(LinkedHashMap<T,java.lang.Object> map)
-
-
Method Detail
-
empty
public static <T> LinkedHashSet<T> empty()
Returns the empty LinkedHashSet.- Type Parameters:
T- Component type- Returns:
- The empty LinkedHashSet.
-
wrap
static <T> LinkedHashSet<T> wrap(LinkedHashMap<T,java.lang.Object> map)
-
collector
public static <T> java.util.stream.Collector<T,java.util.ArrayList<T>,LinkedHashSet<T>> collector()
Returns aCollectorwhich 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 aLinkedHashSet<? extends T>toLinkedHashSet<T>via a type-safe cast. Safe here because the set is immutable and no elements can be added that would violate the type (covariance)- Type Parameters:
T- the target element type- Parameters:
linkedHashSet- the set to narrow- Returns:
- the same set viewed as
LinkedHashSet<T>
-
of
public static <T> LinkedHashSet<T> of(T element)
Returns a singletonLinkedHashSet, i.e. aLinkedHashSetof 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 @NonNull ... 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- ifelementsis null
-
tabulate
public static <T> LinkedHashSet<T> tabulate(int n, @NonNull java.util.function.Function<? super java.lang.Integer,? extends T> f)
Returns a LinkedHashSet containingnvalues of a given Functionfover 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- iffis null
-
fill
public static <T> LinkedHashSet<T> fill(int n, @NonNull java.util.function.Supplier<? extends T> s)
Returns a LinkedHashSet containing tuples returned byncalls 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- ifsis null
-
ofAll
public static <T> LinkedHashSet<T> ofAll(@NonNull 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(@NonNull 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 @NonNull ... 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 @NonNull ... 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 @NonNull ... 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 @NonNull ... 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 @NonNull ... 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 @NonNull ... 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 @NonNull ... 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 @NonNull ... 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)
Creates a LinkedHashSet of char numbers starting fromfrom, extending totoExclusive - 1.Examples:
LinkedHashSet.range('a', 'a') // = LinkedHashSet() LinkedHashSet.range('c', 'a') // = LinkedHashSet() LinkedHashSet.range('a', 'c') // = LinkedHashSet('a', 'b')- Parameters:
from- the first numbertoExclusive- the last number + 1- Returns:
- a range of char values as specified or the empty range if
from >= 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 >= toInclusiveandstep > 0or
from <= toInclusiveandstep < 0 - Throws:
java.lang.IllegalArgumentException- ifstepis zero
-
rangeBy
public static LinkedHashSet<java.lang.Character> rangeBy(char from, char toExclusive, int step)
Creates a LinkedHashSet of char numbers starting fromfrom, extending totoExclusive - 1, withstep.Examples:
LinkedHashSet.rangeBy('a', 'c', 1) // = LinkedHashSet('a', 'b') LinkedHashSet.rangeBy('a', 'd', 2) // = LinkedHashSet('a', 'c') LinkedHashSet.rangeBy('d', 'a', -2) // = LinkedHashSet('d', 'b') LinkedHashSet.rangeBy('d', 'a', 2) // = LinkedHashSet()- Parameters:
from- the first numbertoExclusive- the last number + 1step- the step- Returns:
- a range of char values as specified or the empty range if
from >= toExclusiveandstep > 0or
from <= toExclusiveandstep < 0 - Throws:
java.lang.IllegalArgumentException- ifstepis zero
-
rangeBy
@GwtIncompatible public static LinkedHashSet<java.lang.Double> rangeBy(double from, double toExclusive, double step)
Creates a LinkedHashSet of double numbers starting fromfrom, extending totoExclusive - 1, withstep.Examples:
LinkedHashSet.rangeBy(1.0, 3.0, 1.0) // = LinkedHashSet(1.0, 2.0) LinkedHashSet.rangeBy(1.0, 4.0, 2.0) // = LinkedHashSet(1.0, 3.0) LinkedHashSet.rangeBy(4.0, 1.0, -2.0) // = LinkedHashSet(4.0, 2.0) LinkedHashSet.rangeBy(4.0, 1.0, 2.0) // = LinkedHashSet()- Parameters:
from- the first numbertoExclusive- the last number + 1step- the step- Returns:
- a range of double values as specified or the empty range if
from >= toExclusiveandstep > 0or
from <= toExclusiveandstep < 0 - Throws:
java.lang.IllegalArgumentException- ifstepis zero
-
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 >= toInclusiveandstep > 0or
from <= toInclusiveandstep < 0 - Throws:
java.lang.IllegalArgumentException- ifstepis 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)
Creates a LinkedHashSet of char numbers starting fromfrom, extending totoInclusive.Examples:
LinkedHashSet.rangeClosed('a', 'a') // = LinkedHashSet('a') LinkedHashSet.rangeClosed('c', 'a') // = LinkedHashSet() LinkedHashSet.rangeClosed('a', 'c') // = LinkedHashSet('a', 'b', 'c')- Parameters:
from- the first numbertoInclusive- the last number- Returns:
- a range of char values as specified or the empty range if
from > 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 > toInclusiveandstep > 0or
from < toInclusiveandstep < 0 - Throws:
java.lang.IllegalArgumentException- ifstepis zero
-
rangeClosedBy
public static LinkedHashSet<java.lang.Character> rangeClosedBy(char from, char toInclusive, int step)
Creates a LinkedHashSet of char numbers starting fromfrom, extending totoInclusive, withstep.Examples:
LinkedHashSet.rangeClosedBy('a', 'c', 1) // = LinkedHashSet('a', 'b', 'c') LinkedHashSet.rangeClosedBy('a', 'd', 2) // = LinkedHashSet('a', 'c') LinkedHashSet.rangeClosedBy('d', 'a', -2) // = LinkedHashSet('d', 'b') LinkedHashSet.rangeClosedBy('d', 'a', 2) // = LinkedHashSet()- Parameters:
from- the first numbertoInclusive- the last numberstep- the step- Returns:
- a range of char values as specified or the empty range if
from > toInclusiveandstep > 0or
from < toInclusiveandstep < 0 - Throws:
java.lang.IllegalArgumentException- ifstepis zero
-
rangeClosedBy
@GwtIncompatible public static LinkedHashSet<java.lang.Double> rangeClosedBy(double from, double toInclusive, double step)
Creates a LinkedHashSet of double numbers starting fromfrom, extending totoInclusive, withstep.Examples:
LinkedHashSet.rangeClosedBy(1.0, 3.0, 1.0) // = LinkedHashSet(1.0, 2.0, 3.0) LinkedHashSet.rangeClosedBy(1.0, 4.0, 2.0) // = LinkedHashSet(1.0, 3.0) LinkedHashSet.rangeClosedBy(4.0, 1.0, -2.0) // = LinkedHashSet(4.0, 2.0) LinkedHashSet.rangeClosedBy(4.0, 1.0, 2.0) // = LinkedHashSet()- Parameters:
from- the first numbertoInclusive- the last numberstep- the step- Returns:
- a range of double values as specified or the empty range if
from > toInclusiveandstep > 0or
from < toInclusiveandstep < 0 - Throws:
java.lang.IllegalArgumentException- ifstepis zero
-
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 > toInclusiveandstep > 0or
from < toInclusiveandstep < 0 - Throws:
java.lang.IllegalArgumentException- ifstepis 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(@NonNull 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(@NonNull PartialFunction<? super T,? extends R> partialFunction)
Description copied from interface:TraversableApplies aPartialFunctionto all elements that are defined for it and collects the results.For each element in iteration order, the function is first tested:
IfpartialFunction.isDefinedAt(element)true, the element is mapped to typeR:R newElement = partialFunction.apply(element)Note: If this
Traversableis ordered (i.e., extendsOrdered), the caller must ensure that the resulting elements are comparable (i.e., implementComparable).- Specified by:
collectin interfaceSet<T>- Specified by:
collectin interfaceTraversable<T>- Type Parameters:
R- the type of elements in the resultingTraversable- Parameters:
partialFunction- a function that may not be defined for all elements of this traversable- Returns:
- a new
Traversablecontaining the results of applying the partial function
-
contains
public boolean contains(T element)
Description copied from interface:ValueShortcut forexists(e -> Objects.equals(e, element)), tests if the givenelementis contained.
-
diff
public LinkedHashSet<T> diff(@NonNull Set<? extends T> elements)
Description copied from interface:SetReturns a new set containing all elements of this set except those in the given set.
-
distinct
public LinkedHashSet<T> distinct()
Description copied from interface:TraversableReturns a newTraversablecontaining the elements of this instance with all duplicates removed. Element equality is determined usingequals.
-
distinctBy
public LinkedHashSet<T> distinctBy(@NonNull java.util.Comparator<? super T> comparator)
Description copied from interface:TraversableReturns a newTraversablecontaining the elements of this instance without duplicates, as determined by the givencomparator.- Specified by:
distinctByin interfaceSet<T>- Specified by:
distinctByin interfaceTraversable<T>- Parameters:
comparator- a comparator used to determine equality of elements- Returns:
- a new
Traversablewith duplicates removed
-
distinctBy
public <U> LinkedHashSet<T> distinctBy(@NonNull java.util.function.Function<? super T,? extends U> keyExtractor)
Description copied from interface:TraversableReturns a newTraversablecontaining the elements of this instance without duplicates, based on keys extracted from elements usingkeyExtractor.The first occurrence of each key is retained in the resulting sequence.
- Specified by:
distinctByin interfaceSet<T>- Specified by:
distinctByin interfaceTraversable<T>- Type Parameters:
U- the type of key- Parameters:
keyExtractor- a function to extract keys for determining uniqueness- Returns:
- a new
Traversablewith duplicates removed based on keys
-
drop
public LinkedHashSet<T> drop(int n)
Description copied from interface:TraversableReturns a newTraversablewithout the firstnelements, or an empty instance if this contains fewer thannelements.
-
dropRight
public LinkedHashSet<T> dropRight(int n)
Description copied from interface:TraversableReturns a newTraversablewithout the lastnelements, or an empty instance if this contains fewer thannelements.
-
dropUntil
public LinkedHashSet<T> dropUntil(@NonNull java.util.function.Predicate<? super T> predicate)
Description copied from interface:TraversableReturns a newTraversablestarting from the first element that satisfies the givenpredicate, dropping all preceding elements.
-
dropWhile
public LinkedHashSet<T> dropWhile(@NonNull java.util.function.Predicate<? super T> predicate)
Description copied from interface:TraversableReturns a newTraversablestarting from the first element that does not satisfy the givenpredicate, dropping all preceding elements.This is equivalent to
dropUntil(predicate.negate()), which is useful for method references that cannot be negated directly.
-
filter
public LinkedHashSet<T> filter(@NonNull java.util.function.Predicate<? super T> predicate)
Description copied from interface:TraversableReturns a new traversable containing only the elements that satisfy the given predicate.
-
reject
public LinkedHashSet<T> reject(@NonNull java.util.function.Predicate<? super T> predicate)
Description copied from interface:TraversableReturns a new traversable containing only the elements that do not satisfy the given predicate.This is equivalent to
filter(predicate.negate()).
-
flatMap
public <U> LinkedHashSet<U> flatMap(@NonNull java.util.function.Function<? super T,? extends java.lang.Iterable<? extends U>> mapper)
Description copied from interface:TraversableTransforms each element of this Traversable into anIterableof elements and flattens the resulting iterables into a single Traversable.- Specified by:
flatMapin interfaceSet<T>- Specified by:
flatMapin interfaceTraversable<T>- Type Parameters:
U- the type of elements in the resulting Traversable- Parameters:
mapper- a function mapping elements to iterables- Returns:
- a new Traversable containing all elements produced by applying
mapperand flattening
-
foldRight
public <U> U foldRight(U zero, @NonNull java.util.function.BiFunction<? super T,? super U,? extends U> f)Description copied from interface:FoldableFolds the elements of this structure from the right, starting with the givenzerovalue and successively applying thecombinefunction to each element.Folding from the right means that elements are combined starting from the last element and associating each step with the accumulated result so far.
Example:
// Result: "!cba" List.of("a", "b", "c").foldRight("!", (x, acc) -> acc + x);- Specified by:
foldRightin interfaceFoldable<T>- Specified by:
foldRightin interfaceTraversable<T>- Type Parameters:
U- the type of the accumulated result- Parameters:
zero- the initial value to start folding withf- a function that combines the next element and the accumulated value- Returns:
- the folded result
-
groupBy
public <C> Map<C,LinkedHashSet<T>> groupBy(@NonNull java.util.function.Function<? super T,? extends C> classifier)
Description copied from interface:TraversableGroups elements of thisTraversablebased on a classifier function.- Specified by:
groupByin interfaceSet<T>- Specified by:
groupByin interfaceTraversable<T>- Type Parameters:
C- The type of the group keys- Parameters:
classifier- A function that assigns each element to a group- Returns:
- A map where each key corresponds to a group of elements
- See Also:
Traversable.arrangeBy(Function)
-
grouped
public Iterator<LinkedHashSet<T>> grouped(int size)
Description copied from interface:TraversableSplits thisTraversableinto consecutive blocks of the given size.Let
lengthbe the number of elements in thisTraversable:- If empty, the resulting
Iteratoris empty. - If
size <= length, the resultingIteratorcontainslength / sizeblocks of sizesizeand possibly a final smaller block of sizelength % size. - If
size > length, the resultingIteratorcontains a single block of sizelength.
Examples:
[].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]]Note:
grouped(size)is equivalent tosliding(size, size). - If empty, the resulting
-
hasDefiniteSize
public boolean hasDefiniteSize()
Description copied from interface:TraversableIndicates whether thisTraversablehas a known finite size.This should typically be implemented by concrete classes, not interfaces.
- Specified by:
hasDefiniteSizein interfaceTraversable<T>- Returns:
trueif the number of elements is finite and known,falseotherwise.
-
head
public T head()
Description copied from interface:TraversableReturns the first element of this non-emptyTraversable.- Specified by:
headin interfaceTraversable<T>- Returns:
- the first element
-
headOption
public Option<T> headOption()
Description copied from interface:TraversableReturns the first element of thisTraversableas anOption.- Specified by:
headOptionin interfaceTraversable<T>- Returns:
Some(element)if non-empty, otherwiseNone
-
init
public LinkedHashSet<T> init()
Description copied from interface:TraversableReturns all elements of this Traversable except the last one.This is the dual of
Traversable.tail().
-
initOption
public Option<LinkedHashSet<T>> initOption()
Description copied from interface:TraversableReturns all elements of this Traversable except the last one, wrapped in anOption.This is the dual of
Traversable.tailOption().- Specified by:
initOptionin interfaceSet<T>- Specified by:
initOptionin interfaceTraversable<T>- Returns:
Some(traversable)if non-empty, orNoneif this Traversable is empty
-
intersect
public LinkedHashSet<T> intersect(@NonNull Set<? extends T> elements)
Description copied from interface:SetReturns a new set containing only the elements present in both this set and the given set.
-
isAsync
public boolean isAsync()
AnLinkedHashSet's value is computed synchronously.
-
isEmpty
public boolean isEmpty()
Description copied from interface:TraversableChecks if this Traversable contains no elements.
-
isLazy
public boolean isLazy()
AnLinkedHashSet's value is computed eagerly.
-
isTraversableAgain
public boolean isTraversableAgain()
Description copied from interface:TraversableChecks if this Traversable can be traversed multiple times without side effects.Implementations should provide the correct behavior; this is not meant for interfaces alone.
- Specified by:
isTraversableAgainin interfaceTraversable<T>- Returns:
trueif this Traversable is guaranteed to be repeatably traversable,falseotherwise
-
isSequential
public boolean isSequential()
Description copied from interface:TraversableIndicates whether the elements of this Traversable appear in encounter (insertion) order.- Specified by:
isSequentialin interfaceTraversable<T>- Returns:
trueif insertion order is preserved,falseotherwise
-
iterator
public @NonNull Iterator<T> iterator()
Description copied from interface:TraversableReturns an iterator over the elements of this Traversable, implemented viaTraversable.head()andTraversable.tail(). Subclasses may override for a more efficient implementation.
-
last
public T last()
Description copied from interface:TraversableReturns the last element of this Traversable.- Specified by:
lastin interfaceTraversable<T>- Returns:
- the last element
-
length
public int length()
Description copied from interface:TraversableReturns the number of elements in this Traversable.Equivalent to
Traversable.size().
-
map
public <U> LinkedHashSet<U> map(@NonNull java.util.function.Function<? super T,? extends U> mapper)
Description copied from interface:TraversableTransforms the elements of this Traversable to a new type, preserving order if defined.
-
mapTo
public <U> LinkedHashSet<U> mapTo(U value)
Description copied from interface:ValueMaps the underlying value to another fixed value.
-
mapToVoid
public LinkedHashSet<java.lang.Void> mapToVoid()
Description copied from interface:ValueMaps the underlying value to Void
-
mkString
public java.lang.String mkString(java.lang.CharSequence prefix, java.lang.CharSequence delimiter, java.lang.CharSequence suffix)Description copied from interface:TraversableConcatenates the string representations of all elements in this Traversable with a prefix, delimiter, and suffix.Example:
List.of("a", "b", "c").mkString("Chars(", ", ", ")") = "Chars(a, b, c)"- Specified by:
mkStringin interfaceTraversable<T>- Parameters:
prefix- a string prepended to the resultdelimiter- a string placed between elementssuffix- a string appended to the result- Returns:
- a new
Stringcontaining the formatted concatenation of elements
-
orElse
public LinkedHashSet<T> orElse(@NonNull java.lang.Iterable<? extends T> other)
Description copied from interface:TraversableReturns thisTraversableif it is non-empty; otherwise, returns the given alternative.
-
orElse
public LinkedHashSet<T> orElse(@NonNull java.util.function.Supplier<? extends java.lang.Iterable<? extends T>> supplier)
Description copied from interface:TraversableReturns thisTraversableif it is non-empty; otherwise, returns the result of evaluating the given supplier.
-
partition
public Tuple2<LinkedHashSet<T>,LinkedHashSet<T>> partition(@NonNull java.util.function.Predicate<? super T> predicate)
Description copied from interface:TraversableSplits thisTraversableinto two partitions according to a predicate.The first partition contains all elements that satisfy the predicate, and the second contains all elements that do not. The original iteration order is preserved.
-
peek
public LinkedHashSet<T> peek(@NonNull java.util.function.Consumer<? super T> action)
Description copied from interface:ValuePerforms the givenactionon the first element if this is an eager implementation. Performs the givenactionon all elements (the first immediately, successive deferred), if this is a lazy implementation.
-
remove
public LinkedHashSet<T> remove(T element)
Description copied from interface:SetReturns a new set with the given element removed, if it was present.
-
removeAll
public LinkedHashSet<T> removeAll(@NonNull java.lang.Iterable<? extends T> elements)
Description copied from interface:SetReturns a new set with all given elements removed, if present.
-
replace
public LinkedHashSet<T> replace(T currentElement, T newElement)
Description copied from interface:TraversableReplaces the first occurrence ofcurrentElementwithnewElement, if it exists.
-
replaceAll
public LinkedHashSet<T> replaceAll(T currentElement, T newElement)
Description copied from interface:TraversableReplaces all occurrences ofcurrentElementwithnewElement.- Specified by:
replaceAllin interfaceSet<T>- Specified by:
replaceAllin interfaceTraversable<T>- Parameters:
currentElement- the element to be replacednewElement- the replacement element- Returns:
- a new Traversable with all occurrences of
currentElementreplaced bynewElement
-
retainAll
public LinkedHashSet<T> retainAll(@NonNull java.lang.Iterable<? extends T> elements)
Description copied from interface:TraversableRetains only the elements from this Traversable that are contained in the givenelements.
-
scan
public LinkedHashSet<T> scan(T zero, @NonNull java.util.function.BiFunction<? super T,? super T,? extends T> operation)
Description copied from interface:TraversableComputes a prefix scan of the elements of this Traversable.The neutral element
zeromay be applied more than once.
-
scanLeft
public <U> LinkedHashSet<U> scanLeft(U zero, @NonNull java.util.function.BiFunction<? super U,? super T,? extends U> operation)
Description copied from interface:TraversableProduces a collection containing cumulative results of applying the operator from left to right.Will not terminate for infinite collections. The results may vary across runs unless the collection is ordered.
- Specified by:
scanLeftin interfaceSet<T>- Specified by:
scanLeftin interfaceTraversable<T>- Type Parameters:
U- the type of the resulting elements- Parameters:
zero- the initial valueoperation- a binary operator applied to the intermediate result and each element- Returns:
- a new Traversable containing the cumulative results
-
scanRight
public <U> LinkedHashSet<U> scanRight(U zero, @NonNull java.util.function.BiFunction<? super T,? super U,? extends U> operation)
Description copied from interface:TraversableProduces a collection containing cumulative results of applying the operator from right to left.The head of the resulting collection is the last cumulative result. Will not terminate for infinite collections. Results may vary across runs unless the collection is ordered.
- Specified by:
scanRightin interfaceSet<T>- Specified by:
scanRightin interfaceTraversable<T>- Type Parameters:
U- the type of the resulting elements- Parameters:
zero- the initial valueoperation- a binary operator applied to each element and the intermediate result- Returns:
- a new Traversable containing the cumulative results
-
slideBy
public Iterator<LinkedHashSet<T>> slideBy(@NonNull java.util.function.Function<? super T,?> classifier)
Description copied from interface:TraversablePartitions thisTraversableinto consecutive non-overlapping windows according to a classification function.Each window contains elements with the same class, as determined by
classifier. Two consecutive elements belong to the same window only ifclassifierreturns equal values for both. Otherwise, the current window ends and a new window begins with the next element.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:TraversableSlides a window of a givensizeover thisTraversablewith a step size of 1.This is equivalent to calling
Traversable.sliding(int, int)with a step size of 1.
-
sliding
public Iterator<LinkedHashSet<T>> sliding(int size, int step)
Description copied from interface:TraversableSlides a window of a specificsizewith a givenstepover 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(@NonNull java.util.function.Predicate<? super T> predicate)
Description copied from interface:TraversableSplits thisTraversableinto a prefix and remainder according to the givenpredicate.The first element of the returned
Tupleis the longest prefix of elements satisfyingpredicate, and the second element is the remaining elements.
-
tail
public LinkedHashSet<T> tail()
Description copied from interface:TraversableReturns a newTraversablewithout its first element.
-
tailOption
public Option<LinkedHashSet<T>> tailOption()
Description copied from interface:TraversableReturns a newTraversablewithout its first element as anOption.- Specified by:
tailOptionin interfaceSet<T>- Specified by:
tailOptionin interfaceTraversable<T>- Returns:
Some(traversable)if non-empty, otherwiseNone
-
take
public LinkedHashSet<T> take(int n)
Description copied from interface:TraversableReturns the firstnelements of thisTraversable, or all elements ifnexceeds the length.Equivalent to
sublist(0, max(0, min(length(), n))), but safe forn < 0orn > length().If
n < 0, an empty instance is returned. Ifn > length(), the full instance is returned.
-
takeRight
public LinkedHashSet<T> takeRight(int n)
Description copied from interface:TraversableReturns the lastnelements of thisTraversable, or all elements ifnexceeds the length.Equivalent to
sublist(max(0, length() - n), length()), but safe forn < 0orn > length().If
n < 0, an empty instance is returned. Ifn > length(), the full instance is returned.
-
takeUntil
public LinkedHashSet<T> takeUntil(@NonNull java.util.function.Predicate<? super T> predicate)
Description copied from interface:TraversableTakes elements from thisTraversableuntil the given predicate holds for an element.Equivalent to
takeWhile(predicate.negate()), but useful when using method references that cannot be negated directly.
-
takeWhile
public LinkedHashSet<T> takeWhile(@NonNull java.util.function.Predicate<? super T> predicate)
Description copied from interface:TraversableTakes elements from thisTraversablewhile the given predicate holds.
-
transform
public <U> U transform(@NonNull 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- iffis null
-
toJavaSet
public java.util.LinkedHashSet<T> toJavaSet()
Description copied from interface:SetConverts this Vavr set to ajava.util.Set, preserving insertion or sort order.
-
union
public LinkedHashSet<T> union(@NonNull Set<? extends T> elements)
Adds all of the elements ofelementsto 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(@NonNull java.util.function.Function<? super T,Tuple2<? extends T1,? extends T2>> unzipper)
Description copied from interface:TraversableUnzips the elements of thisTraversableby mapping each element to a pair and splitting them into two separateTraversablecollections.- Specified by:
unzipin interfaceSet<T>- Specified by:
unzipin interfaceTraversable<T>- Type Parameters:
T1- type of the first element in the resulting pairsT2- type of the second element in the resulting pairs- Parameters:
unzipper- a function that maps elements of thisTraversableto pairs- Returns:
- a
Tuple2containing twoTraversablecollections with the split elements
-
unzip3
public <T1,T2,T3> Tuple3<LinkedHashSet<T1>,LinkedHashSet<T2>,LinkedHashSet<T3>> unzip3(@NonNull java.util.function.Function<? super T,Tuple3<? extends T1,? extends T2,? extends T3>> unzipper)
Description copied from interface:TraversableUnzips the elements of thisTraversableby mapping each element to a triple and splitting them into three separateTraversablecollections.- Specified by:
unzip3in interfaceSet<T>- Specified by:
unzip3in interfaceTraversable<T>- Type Parameters:
T1- type of the first element in the resulting triplesT2- type of the second element in the resulting triplesT3- type of the third element in the resulting triples- Parameters:
unzipper- a function that maps elements of thisTraversableto triples- Returns:
- a
Tuple3containing threeTraversablecollections with the split elements
-
zip
public <U> LinkedHashSet<Tuple2<T,U>> zip(@NonNull java.lang.Iterable<? extends U> that)
Description copied from interface:TraversableReturns aTraversableformed by pairing elements of thisTraversablewith elements of anotherIterable. Pairing stops when either collection runs out of elements; any remaining elements in the longer collection are ignored.The length of the resulting
Traversableis the minimum of the lengths of thisTraversableandthat.- Specified by:
zipin interfaceSet<T>- Specified by:
zipin interfaceTraversable<T>- Type Parameters:
U- the type of elements in the second half of each pair- Parameters:
that- anIterableproviding the second element of each pair- Returns:
- a new
Traversablecontaining pairs of corresponding elements
-
zipWith
public <U,R> LinkedHashSet<R> zipWith(@NonNull java.lang.Iterable<? extends U> that, @NonNull java.util.function.BiFunction<? super T,? super U,? extends R> mapper)
Description copied from interface:TraversableReturns aTraversableby combining elements of thisTraversablewith elements of anotherIterableusing a mapping function. Pairing stops when either collection runs out of elements.The length of the resulting
Traversableis the minimum of the lengths of thisTraversableandthat.- Specified by:
zipWithin interfaceSet<T>- Specified by:
zipWithin interfaceTraversable<T>- Type Parameters:
U- the type of elements in the second parameter of the mapperR- the type of elements in the resultingTraversable- Parameters:
that- anIterableproviding the second parameter of the mappermapper- a function that combines elements from this andthatinto a new element- Returns:
- a new
Traversablecontaining mapped elements
-
zipAll
public <U> LinkedHashSet<Tuple2<T,U>> zipAll(@NonNull java.lang.Iterable<? extends U> that, T thisElem, U thatElem)
Description copied from interface:TraversableReturns aTraversableformed by pairing elements of thisTraversablewith elements of anotherIterable, filling in placeholder elements when one collection is shorter than the other.The length of the resulting
Traversableis the maximum of the lengths of thisTraversableandthat.If this
Traversableis shorter thanthat,thisElemis used as a filler. Conversely, ifthatis shorter,thatElemis used.- Specified by:
zipAllin interfaceSet<T>- Specified by:
zipAllin interfaceTraversable<T>- Type Parameters:
U- the type of elements in the second half of each pair- Parameters:
that- anIterableproviding the second element of each pairthisElem- the element used to fill missing values if thisTraversableis shorter thanthatthatElem- the element used to fill missing values ifthatis shorter than thisTraversable- Returns:
- a new
Traversablecontaining pairs of elements, including fillers as needed
-
zipWithIndex
public LinkedHashSet<Tuple2<T,java.lang.Integer>> zipWithIndex()
Description copied from interface:TraversableZips thisTraversablewith its indices, starting at 0.- Specified by:
zipWithIndexin interfaceSet<T>- Specified by:
zipWithIndexin interfaceTraversable<T>- Returns:
- a new
Traversablecontaining each element paired with its index
-
zipWithIndex
public <U> LinkedHashSet<U> zipWithIndex(@NonNull java.util.function.BiFunction<? super T,? super java.lang.Integer,? extends U> mapper)
Description copied from interface:TraversableZips thisTraversablewith its indices and maps the resulting pairs using the provided mapper.- Specified by:
zipWithIndexin interfaceSet<T>- Specified by:
zipWithIndexin interfaceTraversable<T>- Type Parameters:
U- the type of elements in the resultingTraversable- Parameters:
mapper- a function mapping an element and its index to a new element- Returns:
- a new
Traversablecontaining the mapped elements
-
equals
public boolean equals(java.lang.Object o)
Description copied from interface:TraversableDetermines whether this collection is equal to the given object.In Vavr, there are four basic collection types:
Seq– sequential elementsSet– distinct elementsMap– key-value pairsMultimap– keys mapped to multiple values
- They are of the same collection type (Seq, Set, Map, Multimap)
- They contain the same elements
- For
Seq, the element order is the same
For
MapandMultimap, two entries(key1, value1)and(key2, value2)are equal if both their keys and values are equal.Additional notes:
- No collection equals
null(e.g.,Queue(1) != null) - Null elements are allowed and treated as expected
(e.g.,
List(null, 1) == Stream(null, 1),HashMap((null,1)) == LinkedHashMap((null,1))) - Element order matters only for
Seq - Other collection classes are equal if their types and elements (in iteration order) are equal
- Iterators are compared by reference only
-
hashCode
public int hashCode()
Description copied from interface:TraversableReturns the hash code of this collection.Vavr distinguishes between collections with predictable iteration order (like
Seq) and collections with arbitrary iteration order (likeSet,Map, andMultimap). In all cases, the hash of an empty collection is defined as1.For collections with predictable iteration order, the hash is computed as:
int hash = 1; for (T t : this) { hash = hash * 31 + Objects.hashCode(t); }For collections with arbitrary iteration order, the hash is computed to be independent of element order:
int hash = 1; for (T t : this) { hash += Objects.hashCode(t); }Note that these algorithms may change in future Vavr versions. Hash codes are generally not cached, unlike size/length, because caching would increase memory usage due to persistent tree-based structures. Computing the hash code is linear in time, O(n). For frequently re-used collections (e.g., as
HashMapkeys), caching can be done externally using a wrapper, for example:{@code public final class Hashed{ private final K key; private final Lazy hashCode; public Hashed(K key) { this.key = key; this.hashCode = Lazy.of(() -> Objects.hashCode(key)); } public K key() { return key; }
-
stringPrefix
public java.lang.String stringPrefix()
Description copied from interface:ValueReturns the name of this Value type, which is used by toString().- Specified by:
stringPrefixin interfaceValue<T>- Returns:
- This type name.
-
toString
public java.lang.String toString()
Description copied from interface:ValueClarifies that values have a proper toString() method implemented.See Object.toString().
-
addAll
private static <T> LinkedHashMap<T,java.lang.Object> addAll(LinkedHashMap<T,java.lang.Object> initial, java.lang.Iterable<? extends T> additional)
-
writeReplace
@GwtIncompatible("The Java serialization protocol is explicitly not supported") private java.lang.Object writeReplace()
writeReplacemethod for the serialization proxy pattern.The presence of this method causes the serialization system to emit a SerializationProxy instance instead of an instance of the enclosing class.
- Returns:
- A SerializationProxy for this enclosing class.
-
readObject
@GwtIncompatible("The Java serialization protocol is explicitly not supported") private void readObject(java.io.ObjectInputStream stream) throws java.io.InvalidObjectException
readObjectmethod for the serialization proxy pattern.Guarantees that the serialization system will never generate a serialized instance of the enclosing class.
- Parameters:
stream- An object serialization stream.- Throws:
java.io.InvalidObjectException- This method will throw with the message "Proxy required".
-
-