uk.co.strangeskies.property

Interface Property<T>

Type Parameters:

T - The type of the property.

All Known Subinterfaces:

LocaleManager, ObservableProperty<T>

All Known Implementing Classes:

IdentityExpression, IdentityProperty, LocaleManagerService, ObservablePropertyImpl

public interface Property<T>

This interface represents a gettable and settable property of a given type.

Method Summary

Modifier and Type	Method and Description
T	get() Get the current value of the property.
default <U> Property<U>	map(java.util.function.Function<? super T,? extends U> out, java.util.function.Function<? super U,? extends T> in)
static <T> Property<T>	over(java.util.function.Supplier<T> get, java.util.function.Consumer<T> set) Create a property which defers its implementation to the given callbacks.
T	set(T to) Set the value of this property to the given value.
default Property<T>	setDefault(java.util.function.Supplier<T> defaultValue)
default java.util.Optional<T>	tryGet()
default T	unset() Set the value of this property to null.

Method Detail

set

T set(T to)

Set the value of this property to the given value.

Parameters:

to - The new value to set for this property.

Returns:

The previous value of this property.

unset

default T unset()

Set the value of this property to null. This may throw a NullPointerException if null values are not supported by the underlying implementation.

Returns:

The previous value of this property.

get

T get()

Get the current value of the property.

Returns:

The current value.

tryGet

default java.util.Optional<T> tryGet()

setDefault

default Property<T> setDefault(java.util.function.Supplier<T> defaultValue)

map

default <U> Property<U> map(java.util.function.Function<? super T,? extends U> out,
                            java.util.function.Function<? super U,? extends T> in)

over

static <T> Property<T> over(java.util.function.Supplier<T> get,
                            java.util.function.Consumer<T> set)

Create a property which defers its implementation to the given callbacks.

Parameters:

get - the property retrieval callback

set - the property assignment callback

Returns:

a property over the given callbacks