com.netflix.archaius.api

Interface Property<T>

Type Parameters:

T -

All Superinterfaces:

java.util.function.Supplier<T>

public interface Property<T>
extends java.util.function.Supplier<T>

API for composable property access with optional chaining with default value support as well as change notification. A PropertyRepository implementation normally implements some level of caching to reduce the overhead of interpolating and converting values. class MyService { private final Property<String> prop; MyService(PropertyRepository repository) { prop = repository.get("foo.prop", String.class).orElse("defaultValue"); } public void doSomething() { String currentValue = prop.get(); } }

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Property.Subscription Token returned when calling subscribe(Consumer) or onChange(Consumer) through which change notification can be unsubscribed.

Method Summary

Modifier and Type	Method and Description
default void	addListener(PropertyListener<T> listener) Deprecated. Use subscribe(Consumer) instead
T	get() Return the most recent value of the property.
java.lang.String	getKey()
default <S> Property<S>	map(java.util.function.Function<T,S> mapper) Create a new Property object that will map the current object's property value to a new type.
default Property.Subscription	onChange(java.util.function.Consumer<T> consumer) Deprecated. Use subscribe(Consumer) instead.
default Property<T>	orElse(T defaultValue) Create a new Property object that will return the specified defaultValue if this object's property is not found.
default Property<T>	orElseGet(java.lang.String key) Create a new Property object that will fetch the property backed by the provided key.
default void	removeListener(PropertyListener<T> listener) Deprecated. Use the Property.Subscription object returned by subscribe(Consumer) instead.
default Property.Subscription	subscribe(java.util.function.Consumer<T> consumer) Subscribe for notification whenever the property value changes.

Method Detail

get

T get()

Return the most recent value of the property.

Specified by:

get in interface java.util.function.Supplier<T>

Returns:

Most recent value for the property

addListener

@Deprecated
default void addListener(PropertyListener<T> listener)

Deprecated. Use subscribe(Consumer) instead

Add a listener that will be called whenever the property value changes.

removeListener

@Deprecated
default void removeListener(PropertyListener<T> listener)

Deprecated. Use the Property.Subscription object returned by subscribe(Consumer) instead.

Remove a listener previously registered by calling addListener

onChange

@Deprecated
default Property.Subscription onChange(java.util.function.Consumer<T> consumer)

Deprecated. Use subscribe(Consumer) instead.

subscribe

default Property.Subscription subscribe(java.util.function.Consumer<T> consumer)

Subscribe for notification whenever the property value changes. onChange(Consumer) should be called last when chaining properties since the notification only applies to the state of the chained property up until this point. Changes to subsequent Property objects returned from orElse(T) or map(Function) will not trigger calls to this consumer.

Returns:

Subscription that may be unsubscribed to no longer get change notifications

orElse

default Property<T> orElse(T defaultValue)

Create a new Property object that will return the specified defaultValue if this object's property is not found.

Returns:

Newly constructed Property object

orElseGet

default Property<T> orElseGet(java.lang.String key)

Create a new Property object that will fetch the property backed by the provided key. The return value of the supplier will be cached until the configuration has changed

Returns:

Newly constructed Property object

map

default <S> Property<S> map(java.util.function.Function<T,S> mapper)

Create a new Property object that will map the current object's property value to a new type. The return value of the mapper will be cached until the configuration has changed. Note that no orElseGet() calls may be made on a mapped property

Returns:

Newly constructed Property object

getKey

java.lang.String getKey()

Returns:

Key or path to the property