Module is.codion.common.core

Package is.codion.common.value

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

Type Parameters:

T - the value type

C - the collection type

All Superinterfaces:

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

All Known Subinterfaces:

ValueList<T>, ValueSet<T>

public interface Values<T,C extends Collection<T>>
extends Value<C>, ObservableValues<T,C>

An observable wrapper for one or more values.

See Also:

• ValueSet
• ValueList

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	Values.Builder<T,C extends Collection<T>,B extends Values.Builder<T,C,B>>	Builds a Values 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 Values instance.
boolean	addAll(Collection<T> values)	Adds the given values to this Values instance.
boolean	addAll(T... values)	Adds the given values to this Values instance.
@NonNull C	get()
default boolean	isNullable()	If false then get() is guaranteed to never return null.
ObservableValues<T,C>	observable()	Returns an ObservableValues notified each time this value changes.
boolean	remove(@Nullable T value)	Removes a single instance of the given value from this Values instance.
boolean	removeAll(Collection<T> values)	Removes the given values from this Values instance.
boolean	removeAll(T... values)	Removes the given values from this Values instance.
boolean	set(@Nullable Collection<T> values)	Sets the values.
Value<T>	value()	Returns a Value instance based on this Values.

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

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

addConsumer, addListener, addWeakConsumer, addWeakListener, getOrThrow, getOrThrow, isEqualTo, isNotEqualTo, isNull, observer, optional, removeConsumer, removeListener, removeWeakConsumer, removeWeakListener

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

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 ObservableValues<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

boolean set(@Nullable Collection<T> values)

Sets the values.

Parameters:

values - the values to set

Returns:

true if this Values instance changed

add

boolean add(@Nullable T value)

Adds a value to this Values 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 Values 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 Values 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 Values 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 Values 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 Values 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 Values. Setting this value to null clears the values. This value consistently returns the first value from the underlying Values in case it is sequenced and contains multiple items.

Returns:

a single item value based on this values instance

observable

ObservableValues<T,C> observable()

Returns an ObservableValues notified each time this value changes.

Specified by:

observable in interface Value<T>

Returns:

an ObservableValues for this value