org.wildfly.swarm.spi.api

Class StageConfig

java.lang.Object

org.wildfly.swarm.spi.api.StageConfig

public class StageConfig
extends Object

Handle to stage-centric configuration items.

A view into ProjectStage for an active set of configuration items.

Since:

19/04/16

Author:

Heiko Braun

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	StageConfig.Builder<T>
static interface	StageConfig.Converter<T> Converter capable of converting a native String value to a specific type.
static interface	StageConfig.Resolver<T> Coercing resolver for a given configuration item.

Constructor Summary

Constructors

Constructor and Description
StageConfig(ProjectStage stage)

Method Summary

Modifier and Type	Method and Description
String	getName() Retrieve the name of this stage.
boolean	hasKeyOrSubkeys(String key) Determine if the specified key or any sub-keys exists.
Set<String>	keys() Retrieve the set of explicit keys in the stage.
StageConfig.Resolver<String>	resolve(String name) Obtain a resolver for a given configuration item name.
Set<String>	simpleSubkeys(String prefix) Retrieve the set of sub-keys that are immediately underneath the specified prefix.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StageConfig

public StageConfig(ProjectStage stage)

Method Detail

resolve

public StageConfig.Resolver<String> resolve(String name)

Obtain a resolver for a given configuration item name.

While the default resolver is String-based, the resolver can be used to obtain the configuration value as a different type.

Parameters:

name - The configuration item name.

Returns:

The resolver for the configuration item.

keys

public Set<String> keys()

Retrieve the set of explicit keys in the stage.

Returns:

The set of keys.

simpleSubkeys

public Set<String> simpleSubkeys(String prefix)

Retrieve the set of sub-keys that are immediately underneath the specified prefix.

If, for example, a prefix of swarm.foo.bar is provided as the parameter, and there exists the following complete keys:

• swarm.foo.bar.x
• swarm.foo.bar.y
• swarm.foo.bar.z
• swarm.foo.barbara

Then this method would return simply the set of [x, y, z]

Parameters:

prefix - The prefix to search for.

Returns:

hasKeyOrSubkeys

public boolean hasKeyOrSubkeys(String key)

Determine if the specified key or any sub-keys exists.

Parameters:

key - The key to test.

Returns:

true if the key or any sub-key exists, otherwise false.

getName

public String getName()

Retrieve the name of this stage.

Returns:

The name of this stage.