org.apache.brooklyn.core.config.internal

Class LazyContainerAndKeyValue<TContainer,TValue>

java.lang.Object

org.apache.brooklyn.core.config.internal.LazyContainerAndKeyValue<TContainer,TValue>

All Implemented Interfaces:

com.google.common.base.Supplier<TValue>, ConfigValueAtContainer<TContainer,TValue>

public class LazyContainerAndKeyValue<TContainer,TValue>
extends java.lang.Object
implements ConfigValueAtContainer<TContainer,TValue>

Constructor Summary

Constructors

Constructor and Description
LazyContainerAndKeyValue(ConfigKey<TValue> key, TContainer container, com.google.common.base.Function<TContainer,Maybe<java.lang.Object>> lookupResolutionFunction, com.google.common.base.Function<Maybe<java.lang.Object>,Maybe<TValue>> conversionFunction)

Method Summary

Modifier and Type	Method and Description
Maybe<TValue>	asMaybe() Absent if no value can be found, typically meaning no default value, but in raw value lookups it may ignore default values.
TValue	get() Returns the value for this key, or null.
TContainer	getContainer() The container where the value was found (possibly an ancestor of the queried object).
Maybe<TValue>	getDefaultValue() The default value on the key, if available and permitted, possibly coerced or resolved in the scope of ConfigValueAtContainer.getContainer(), and possibly absent e.g.
ConfigKey<TValue>	getKey() The key whose value is being held here.
boolean	isValueExplicitlySet() If false, any contents of ConfigValueAtContainer.get() will have come from ConfigValueAtContainer.getDefaultValue().
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

LazyContainerAndKeyValue

public LazyContainerAndKeyValue(@Nullable
                                ConfigKey<TValue> key,
                                @Nullable
                                TContainer container,
                                com.google.common.base.Function<TContainer,Maybe<java.lang.Object>> lookupResolutionFunction,
                                com.google.common.base.Function<Maybe<java.lang.Object>,Maybe<TValue>> conversionFunction)

Method Detail

getContainer

public TContainer getContainer()

Description copied from interface: ConfigValueAtContainer

The container where the value was found (possibly an ancestor of the queried object). This may be null in internal uses to indicate an anonymous query.

Specified by:

getContainer in interface ConfigValueAtContainer<TContainer,TValue>

get

public TValue get()

Description copied from interface: ConfigValueAtContainer

Returns the value for this key, or null. Technically this returns ConfigValueAtContainer.asMaybe() or null.

Specified by:

get in interface com.google.common.base.Supplier<TValue>

Specified by:

get in interface ConfigValueAtContainer<TContainer,TValue>

asMaybe

public Maybe<TValue> asMaybe()

Description copied from interface: ConfigValueAtContainer

Absent if no value can be found, typically meaning no default value, but in raw value lookups it may ignore default values.

Specified by:

asMaybe in interface ConfigValueAtContainer<TContainer,TValue>

isValueExplicitlySet

public boolean isValueExplicitlySet()

Description copied from interface: ConfigValueAtContainer

If false, any contents of ConfigValueAtContainer.get() will have come from ConfigValueAtContainer.getDefaultValue().

Specified by:

isValueExplicitlySet in interface ConfigValueAtContainer<TContainer,TValue>

getKey

public ConfigKey<TValue> getKey()

Description copied from interface: ConfigValueAtContainer

The key whose value is being held here.

This may be null when working in a context where the query key is widely known to indicate that no key was defined at this container.

Specified by:

getKey in interface ConfigValueAtContainer<TContainer,TValue>

getDefaultValue

public Maybe<TValue> getDefaultValue()

Description copied from interface: ConfigValueAtContainer

The default value on the key, if available and permitted, possibly coerced or resolved in the scope of ConfigValueAtContainer.getContainer(), and possibly absent e.g. in raw value lookups

Specified by:

getDefaultValue in interface ConfigValueAtContainer<TContainer,TValue>

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object