org.apache.brooklyn.config

Class ConfigInheritances.BasicConfigValueAtContainer<TContainer,TValue>

java.lang.Object

org.apache.brooklyn.config.ConfigInheritances.BasicConfigValueAtContainer<TContainer,TValue>

All Implemented Interfaces:

ConfigValueAtContainer<TContainer,TValue>

Enclosing class:

ConfigInheritances

public static class ConfigInheritances.BasicConfigValueAtContainer<TContainer,TValue>
extends java.lang.Object
implements ConfigValueAtContainer<TContainer,TValue>

Constructor Summary

Constructors

Constructor and Description
BasicConfigValueAtContainer()
BasicConfigValueAtContainer(ConfigValueAtContainer<TContainer,TValue> toCopy)
BasicConfigValueAtContainer(TContainer container, ConfigKey<? extends TValue> key, Maybe<? extends TValue> value)
BasicConfigValueAtContainer(TContainer container, ConfigKey<? extends TValue> key, Maybe<? extends TValue> value, boolean isValueSet)
BasicConfigValueAtContainer(TContainer container, ConfigKey<? extends TValue> key, Maybe<? extends TValue> value, boolean isValueSet, Maybe<TValue> defaultValue) Creates an instance, configuring all parameters.

Method Summary

Modifier and Type	Method and Description
Maybe<? extends 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<? extends 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().
void	setContainer(TContainer container)
void	setKey(ConfigKey<? extends TValue> key)
void	setValue(Maybe<? extends TValue> value)
void	setValueWasExplicitlySet(boolean valueWasExplicitlySet)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicConfigValueAtContainer

public BasicConfigValueAtContainer()

BasicConfigValueAtContainer

public BasicConfigValueAtContainer(ConfigValueAtContainer<TContainer,TValue> toCopy)

BasicConfigValueAtContainer

public BasicConfigValueAtContainer(@Nullable
                                   TContainer container,
                                   @Nullable
                                   ConfigKey<? extends TValue> key,
                                   @Nullable
                                   Maybe<? extends TValue> value)

BasicConfigValueAtContainer

public BasicConfigValueAtContainer(@Nullable
                                   TContainer container,
                                   @Nullable
                                   ConfigKey<? extends TValue> key,
                                   @Nullable
                                   Maybe<? extends TValue> value,
                                   boolean isValueSet)

BasicConfigValueAtContainer

public BasicConfigValueAtContainer(@Nullable
                                   TContainer container,
                                   @Nullable
                                   ConfigKey<? extends TValue> key,
                                   @Nullable
                                   Maybe<? extends TValue> value,
                                   boolean isValueSet,
                                   @Nullable
                                   Maybe<TValue> defaultValue)

Creates an instance, configuring all parameters.

Parameters:

container - May be null as per contract.

key - May be null as per contract.

value - Null means always to take getDefaultValue(); if absent and isValueSet is false, it will also take getDefaultValue().

isValueSet -

defaultValue - Null means to take a default value from the key (getKey()), otherwise this Maybe will be preferred to that value (even if absent).

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 ConfigValueAtContainer<TContainer,TValue>

asMaybe

public Maybe<? extends 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<? extends 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>

setContainer

public void setContainer(TContainer container)

setValue

public void setValue(Maybe<? extends TValue> value)

setValueWasExplicitlySet

public void setValueWasExplicitlySet(boolean valueWasExplicitlySet)

setKey

public void setKey(ConfigKey<? extends TValue> key)

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