Module is.codion.common.core

Package is.codion.common.value

Interface ValueCollection<T,C extends Collection<T>>

Type Parameters:

T - the value type

C - the collection type

All Superinterfaces:

Iterable<T>, Observable<C>, ObservableValueCollection<T,C>, Observer<C>, Value<C>

All Known Subinterfaces:

ValueList<T>, ValueSet<T>

public interface ValueCollection<T,C extends Collection<T>>
extends Value<C>, ObservableValueCollection<T,C>

An observable wrapper for one or more values.

All implementations are thread-safe and support concurrent access.

See Also:

• ValueSet
• ValueList

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ValueCollection.Builder<T,C extends Collection<T>,B extends ValueCollection.Builder<T,C,B>>	Builds a ValueCollection instance.

Nested classes/interfaces inherited from interface is.codion.common.value.Value

Value.BuilderFactory, Value.Notify, Value.Validator<T>

Method Summary

Modifier and Type	Method	Description
boolean	add(@Nullable T value)	Adds a value to this ValueCollection instance.
boolean	addAll(Collection<T> values)	Adds the given values to this ValueCollection instance.
boolean	addAll(T... values)	Adds the given values to this ValueCollection instance.
@NonNull C	get()
default boolean	isNullable()	If false then get() is guaranteed to never return null.
ObservableValueCollection<T,C>	observable()	Returns an ObservableValueCollection notified each time this value changes.
Optional<C>	optional()
boolean	remove(@Nullable T value)	Removes a single instance of the given value from this ValueCollection instance.
boolean	removeAll(Collection<T> values)	Removes the given values from this ValueCollection instance.
boolean	removeAll(T... values)	Removes the given values from this ValueCollection instance.
void	set(@Nullable Collection<T> values)	Sets the values.
Value<T>	value()	Returns a Value instance based on this ValueCollection.

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Methods inherited from interface is.codion.common.observer.Observable

addConsumer, addListener, addWeakConsumer, addWeakListener, getOrThrow, getOrThrow, is, isNot, isNull, observer, removeConsumer, removeListener, removeWeakConsumer, removeWeakListener

Methods inherited from interface is.codion.common.value.ObservableValueCollection

contains, containsAll, isEmpty, size

Methods inherited from interface is.codion.common.value.Value

addValidator, clear, link, link, map, removeValidator, set, unlink, unlink, validate

Method Details

get

@NonNull C get()

Specified by:

get in interface Observable<T>

Specified by:

get in interface ObservableValueCollection<T,C extends Collection<T>>

Returns:

the value

isNullable

default boolean isNullable()

Description copied from interface: Observable

If false then get() is guaranteed to never return null.

Specified by:

isNullable in interface Observable<T>

Returns:

true if this observable can be null

set

void set(@Nullable Collection<T> values)

Sets the values.

Parameters:

values - the values to set

add

boolean add(@Nullable T value)

Adds a value to this ValueCollection instance.

Parameters:

value - the value to add

Returns:

true if the value was added

See Also:

• Collection.add(Object)

addAll

boolean addAll(T... values)

Adds the given values to this ValueCollection instance.

Parameters:

values - the values to add

Returns:

true if a value was added

See Also:

• Collection.addAll(Collection)

addAll

boolean addAll(Collection<T> values)

Adds the given values to this ValueCollection instance.

Parameters:

values - the values to add

Returns:

true if a value was added

See Also:

• Collection.addAll(Collection)

remove

boolean remove(@Nullable T value)

Removes a single instance of the given value from this ValueCollection instance.

Parameters:

value - the value to remove

Returns:

true if the value was removed

See Also:

• Collection.remove(Object)

removeAll

boolean removeAll(T... values)

Removes the given values from this ValueCollection instance.

Parameters:

values - the values to remove

Returns:

true if a value was removed

See Also:

• Collection.removeAll(Collection)

removeAll

boolean removeAll(Collection<T> values)

Removes the given values from this ValueCollection instance.

Parameters:

values - the values to remove

Returns:

true if a value was removed

See Also:

• Collection.removeAll(Collection)

value

Value<T> value()

Returns a Value instance based on this ValueCollection. Setting this value to null clears the values. This value consistently returns the first value from the underlying ValueCollection in case it is sequenced and contains multiple items.

Returns:

a single item value based on this ValueCollection instance

optional

Optional<C> optional()

Specified by:

optional in interface Observable<T>

Specified by:

optional in interface ObservableValueCollection<T,C extends Collection<T>>

Returns:

the values or an empty Optional if the collection is empty.

observable

ObservableValueCollection<T,C> observable()

Returns an ObservableValueCollection notified each time this value changes.

Specified by:

observable in interface Value<T>

Returns:

an ObservableValueCollection for this value