AbstractStructuredConfigKey (Apache Brooklyn)

java.lang.Object
- brooklyn.event.basic.BasicConfigKey<T>
- - brooklyn.event.basic.AbstractStructuredConfigKey<T,RawT,V>

All Implemented Interfaces:

ConfigKey<T>, StructuredConfigKey, ConfigKeySelfExtracting<T>, java.io.Serializable

Direct Known Subclasses:

AbstractCollectionConfigKey, MapConfigKey
```
public abstract class AbstractStructuredConfigKey<T,RawT,V>
extends BasicConfigKey<T>
implements StructuredConfigKey
```
See Also:
Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class brooklyn.event.basic.BasicConfigKey
  BasicConfigKey.BasicConfigKeyOverwriting<T>, BasicConfigKey.Builder<T>
- Nested classes/interfaces inherited from interface brooklyn.event.basic.StructuredConfigKey
  StructuredConfigKey.StructuredModification<T extends StructuredConfigKey>, StructuredConfigKey.StructuredModifications
- Nested classes/interfaces inherited from interface brooklyn.config.ConfigKey
  ConfigKey.HasConfigKey<T>

Field Summary

Fields
Modifier and Type Field and Description

java.lang.Class<V> subType

Fields
Modifier and Type	Field and Description
`java.lang.Class<V>`	`subType`

Constructor Summary

Constructors
Constructor and Description
`AbstractStructuredConfigKey(java.lang.Class<T> type, java.lang.Class<V> subType, java.lang.String name, java.lang.String description, T defaultValue)`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`acceptsKeyMatch(java.lang.Object contender)`
`boolean`	`acceptsSubkey(java.lang.Object contender)`
`boolean`	`acceptsSubkeyStronglyTyped(java.lang.Object contender)`
`java.lang.String`	`extractSubKeyName(java.lang.Object o)`
`T`	`extractValue(java.util.Map<?,?> vals, ExecutionContext exec)` Retrieves the value corresponding to this config key from the given map.
`boolean`	`isSet(java.util.Map<?,?> vals)`
`RawT`	`rawValue(java.util.Map<?,?> vals)` returns the entries in the map against this config key and any sub-config-keys, without resolving (like `extractValue(Map, ExecutionContext)` but without resolving/coercing; useful because values in this "map" are actually stored against `SubElementConfigKey`s

Methods inherited from class brooklyn.event.basic.BasicConfigKey
builder, builder, builder, builder, builder, equals, getDefaultValue, getDescription, getInheritance, getName, getNameParts, getType, getTypeName, getTypeToken, hasDefaultValue, hashCode, isReconfigurable, toString

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface brooklyn.event.basic.StructuredConfigKey
applyValueToMap

- Field Detail
  - subType
```
public final java.lang.Class<V> subType
```
- Constructor Detail
  - AbstractStructuredConfigKey
```
public AbstractStructuredConfigKey(java.lang.Class<T> type,
                           java.lang.Class<V> subType,
                           java.lang.String name,
                           java.lang.String description,
                           T defaultValue)
```
- Method Detail
  - acceptsKeyMatch
```
public boolean acceptsKeyMatch(java.lang.Object contender)
```
    Specified by:
    
    acceptsKeyMatch in interface StructuredConfigKey
  - acceptsSubkey
```
public boolean acceptsSubkey(java.lang.Object contender)
```
    Specified by:
    
    acceptsSubkey in interface StructuredConfigKey
  - extractSubKeyName
```
public java.lang.String extractSubKeyName(java.lang.Object o)
```
  - acceptsSubkeyStronglyTyped
```
public boolean acceptsSubkeyStronglyTyped(java.lang.Object contender)
```
    Specified by:
    
    acceptsSubkeyStronglyTyped in interface StructuredConfigKey
  - isSet
```
public boolean isSet(java.util.Map<?,?> vals)
```
    Specified by:
    
    isSet in interface ConfigKeySelfExtracting<T>
    
    Overrides:
    
    isSet in class BasicConfigKey<T>
    
    Returns:
    True if there is an entry in the configMap that could be extracted
  - extractValue
```
public T extractValue(java.util.Map<?,?> vals,
             ExecutionContext exec)
```
    Description copied from class: BasicConfigKey
    
    Retrieves the value corresponding to this config key from the given map. Could be overridden by more sophisticated config keys, such as MapConfigKey etc.
    
    Specified by:
    
    extractValue in interface ConfigKeySelfExtracting<T>
    
    Overrides:
    
    extractValue in class BasicConfigKey<T>
  - rawValue
```
public RawT rawValue(java.util.Map<?,?> vals)
```
    returns the entries in the map against this config key and any sub-config-keys, without resolving (like extractValue(Map, ExecutionContext) but without resolving/coercing; useful because values in this "map" are actually stored against SubElementConfigKeys

Class AbstractStructuredConfigKey<T,RawT,V>

Nested Class Summary

Nested classes/interfaces inherited from class brooklyn.event.basic.BasicConfigKey

Nested classes/interfaces inherited from interface brooklyn.event.basic.StructuredConfigKey

Nested classes/interfaces inherited from interface brooklyn.config.ConfigKey

Field Summary

Constructor Summary

Method Summary

Methods inherited from class brooklyn.event.basic.BasicConfigKey

Methods inherited from class java.lang.Object

Methods inherited from interface brooklyn.event.basic.StructuredConfigKey

Field Detail

subType

Constructor Detail

AbstractStructuredConfigKey

Method Detail

acceptsKeyMatch

acceptsSubkey

extractSubKeyName

acceptsSubkeyStronglyTyped

isSet

extractValue

rawValue