Enum Multimap.ContainerType

java.lang.Object

java.lang.Enum<Multimap.ContainerType>

io.vavr.collection.Multimap.ContainerType

All Implemented Interfaces:

Serializable, Comparable<Multimap.ContainerType>, java.lang.constant.Constable

Enclosing interface:

Multimap<K,V>

public static enum Multimap.ContainerType
extends Enum<Multimap.ContainerType>

Defines the type of container used to store values associated with keys in a Multimap. Each type determines how values are stored and how add/remove operations behave.

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
SEQ	Values are stored in a Seq, allowing duplicate values per key and preserving insertion order.
SET	Values are stored in a Set, ensuring uniqueness of values per key.
SORTED_SET	Values are stored in a sorted Set, ensuring uniqueness and natural ordering of values per key.

Field Summary

Fields

Modifier and Type	Field	Description
private final BiFunction<Traversable<?>, Object, Traversable<?>>	add
private final Supplier<Collection<?>>	instantiate
private final BiFunction<Traversable<?>, Object, Traversable<?>>	remove

Constructor Summary

Constructors

Modifier	Constructor	Description
private	ContainerType(BiFunction<Traversable<?>, Object, Traversable<?>> add, BiFunction<Traversable<?>, Object, Traversable<?>> remove, Supplier<Collection<?>> instantiate)

Method Summary

Modifier and Type	Method	Description
(package private) <T> Traversable<T>	add(Traversable<?> container, T elem)
(package private) <T> Collection<T>	instantiate()
(package private) <T> Traversable<T>	remove(Traversable<?> container, T elem)
static Multimap.ContainerType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static Multimap.ContainerType[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

SET

public static final Multimap.ContainerType SET

Values are stored in a Set, ensuring uniqueness of values per key.

SORTED_SET

public static final Multimap.ContainerType SORTED_SET

Values are stored in a sorted Set, ensuring uniqueness and natural ordering of values per key.

SEQ

public static final Multimap.ContainerType SEQ

Values are stored in a Seq, allowing duplicate values per key and preserving insertion order.

Field Details

add

private final BiFunction<Traversable<?>, Object, Traversable<?>> add

remove

private final BiFunction<Traversable<?>, Object, Traversable<?>> remove

instantiate

private final Supplier<Collection<?>> instantiate

Constructor Details

ContainerType

private ContainerType(BiFunction<Traversable<?>, Object, Traversable<?>> add,
 BiFunction<Traversable<?>, Object, Traversable<?>> remove,
 Supplier<Collection<?>> instantiate)

Method Details

values

public static Multimap.ContainerType[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Multimap.ContainerType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

add

<T> Traversable<T> add(Traversable<?> container,
 T elem)

remove

<T> Traversable<T> remove(Traversable<?> container,
 T elem)

instantiate

<T> Collection<T> instantiate()