ConfigResolver.TypedResolver (Apache DeltaSpike Sources 1.8.2 API)

Type Parameters:
T - The target type of the configuration entry.

All Known Subinterfaces:

ConfigResolver.UntypedResolver<T>

Enclosing class:

ConfigResolver
```
public static interface ConfigResolver.TypedResolver<T>
```
A builder-based typed resolution mechanism for configuration values.

Method Summary

Methods
Modifier and Type	Method and Description
`ConfigResolver.TypedResolver<List<T>>`	`asList()` Declare the Resolver to return a List of the given Type.
`ConfigResolver.TypedResolver<T>`	`cacheFor(TimeUnit timeUnit, long value)` Specify that a resolved value will get cached for a certain amount of time.
`ConfigResolver.TypedResolver<T>`	`evaluateVariables(boolean evaluateVariables)` Whether to evaluate variables in configured values.
`T`	`getDefaultValue()` Returns the default value provided by `withDefault(Object)` or `withStringDefault(String)`.
`String`	`getKey()` Returns the key given in `ConfigResolver.resolve(String)`.
`String`	`getResolvedKey()` Returns the actual key which led to successful resolution and corresponds to the resolved value.
`T`	`getValue()` Returns the converted resolved filtered value.
`ConfigResolver.TypedResolver<T>`	`logChanges(boolean logChanges)` Whether to log picking up any value changes as INFO.
`ConfigResolver.TypedResolver<T>`	`parameterizedBy(String propertyName)` Appends the resolved value of the given property to the key of this builder.
`ConfigResolver.TypedResolver<T>`	`strictly(boolean strictly)` Indicates whether the fallback resolution sequence should be performed, as described in `ConfigResolver.getPropertyAwarePropertyValue(String, String)`.
`ConfigResolver.TypedResolver<T>`	`withCurrentProjectStage(boolean with)` Indicates whether to append the name of the current project stage to the key of this builder.
`ConfigResolver.TypedResolver<T>`	`withDefault(T value)` Sets the default value to use in case the resolution returns null.
`ConfigResolver.TypedResolver<T>`	`withStringDefault(String value)` Sets the default value to use in case the resolution returns null.

- Method Detail
  - asList
```
ConfigResolver.TypedResolver<List<T>> asList()
```
    Declare the Resolver to return a List of the given Type. When getting value it will be split on each comma (',') character. If a comma is contained in the values it must get escaped with a preceding backslash ("\,"). Any backslash needs to get escaped via double-backslash ("\\"). Note that in property files this leads to "\\\\" as properties escape themselves.
    
    Returns:
    a TypedResolver for a list of configured comma separated values
    Since:
    
    1.8.0
  - parameterizedBy
```
ConfigResolver.TypedResolver<T> parameterizedBy(String propertyName)
```
    Appends the resolved value of the given property to the key of this builder. This is described in more detail in ConfigResolver.getPropertyAwarePropertyValue(String, String).
    
    Parameters:
    propertyName - The name of the parameter property
    
    Returns:
    This builder
  - withCurrentProjectStage
```
ConfigResolver.TypedResolver<T> withCurrentProjectStage(boolean with)
```
    Indicates whether to append the name of the current project stage to the key of this builder. This is described in more detail in ConfigResolver.getProjectStageAwarePropertyValue(String). True by default.
    
    Parameters:
    with -
    
    Returns:
    This builder
  - strictly
```
ConfigResolver.TypedResolver<T> strictly(boolean strictly)
```
    Indicates whether the fallback resolution sequence should be performed, as described in ConfigResolver.getPropertyAwarePropertyValue(String, String). This applies only when parameterizedBy(String) or withCurrentProjectStage(boolean) is used.
    
    Parameters:
    strictly -
    
    Returns:
    This builder
  - withDefault
```
ConfigResolver.TypedResolver<T> withDefault(T value)
```
    Sets the default value to use in case the resolution returns null.
    
    Parameters:
    value - the default value
    
    Returns:
    This builder
  - withStringDefault
```
ConfigResolver.TypedResolver<T> withStringDefault(String value)
```
    Sets the default value to use in case the resolution returns null. Converts the given String to the type of this resolver using the same method as used for the configuration entries.
    
    Parameters:
    value - string value to be converted and used as default
    
    Returns:
    This builder
  - cacheFor
```
ConfigResolver.TypedResolver<T> cacheFor(TimeUnit timeUnit,
                                       long value)
```
    Specify that a resolved value will get cached for a certain amount of time. After the time expires the next getValue() will again resolve the value from the underlying ConfigResolver.
    
    Parameters:
    timeUnit - the TimeUnit for the value
    value - the amount of the TimeUnit to wait
    
    Returns:
    This builder
  - evaluateVariables
```
ConfigResolver.TypedResolver<T> evaluateVariables(boolean evaluateVariables)
```
    Whether to evaluate variables in configured values. A variable starts with '${' and ends with '}', e.g.
```
 mycompany.some.url=${myserver.host}/some/path
 myserver.host=http://localhost:8081
 
```
    If 'evaluateVariables' is enabled, the result for the above key "mycompany.some.url" would be: "http://localhost:8081/some/path"
    Parameters:
    evaluateVariables - whether to evaluate variables in values or not
    
    Returns:
    This builder
  - logChanges
```
ConfigResolver.TypedResolver<T> logChanges(boolean logChanges)
```
    Whether to log picking up any value changes as INFO.
    
    Returns:
    This builder
  - getValue
```
T getValue()
```
    Returns the converted resolved filtered value.
    
    Returns:
    the resolved value
  - getKey
```
String getKey()
```
    Returns the key given in ConfigResolver.resolve(String).
    
    Returns:
    the original key
  - getResolvedKey
```
String getResolvedKey()
```
    Returns the actual key which led to successful resolution and corresponds to the resolved value. This applies only when parameterizedBy(String) or withCurrentProjectStage(boolean) is used and strictly(boolean) is not used, otherwise the resolved key should always be equal to the original key. This method is provided for cases, when projectStage-aware and/or parameterized resolution is requested but the value for such appended key is not found and some of the fallback keys is used, as described in ConfigResolver.getPropertyAwarePropertyValue(String, String). This should be called only after calling getValue() otherwise the value is undefined (but likely null).
    
    Returns:
  - getDefaultValue
```
T getDefaultValue()
```
    Returns the default value provided by withDefault(Object) or withStringDefault(String). Returns null if no default was provided.
    
    Returns:
    the default value or null

Interface ConfigResolver.TypedResolver<T>

Method Summary

Method Detail

asList

parameterizedBy

withCurrentProjectStage

strictly

withDefault

withStringDefault

cacheFor

evaluateVariables

logChanges

getValue

getKey

getResolvedKey

getDefaultValue