org.apache.juneau.config.vars

Class ConfigVar

java.lang.Object

org.apache.juneau.svl.Var

org.apache.juneau.svl.SimpleVar

org.apache.juneau.svl.DefaultingVar

org.apache.juneau.config.vars.ConfigVar

public class ConfigVar
extends DefaultingVar

Config file variable resolver.

The format for this var is "$C{key[,defaultValue]}". See Config.getString(String) for the format of the key.

This variable resolver requires that a Config object be set as a context object on the resolver or a session object on the resolver session.

Example:

// Create a config object. Config config = Config.create().name("MyConfig.cfg").build(); // Create a variable resolver that resolves config file entries (e.g. "$C{MySection/myKey}") VarResolver r = new VarResolver().addVars(ConfigVar.class) .addContextObject(SESSION_config, configFile); // Use it! System.out.println(r.resolve("Value for myKey in section MySection is $C{MySection/myKey}"));

Since this is a SimpleVar, any variables contained in the result will be recursively resolved. Likewise, if the arguments contain any variables, those will be resolved before they are passed to this var.

• Overview > juneau-marshall > Simple Variable Language > VarResolvers and VarResolverSessions
• Overview > juneau-config > Variables

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME The name of this variable.
static String	SESSION_config The name of the session or context object that identifies the Config object.

Constructor Summary

Constructors

Constructor and Description
ConfigVar() Constructor.

Method Summary

Modifier and Type	Method and Description
String	resolve(VarResolverSession session, String key) The interface that needs to be implemented for subclasses of SimpleVar.

Methods inherited from class org.apache.juneau.svl.DefaultingVar

doResolve

Methods inherited from class org.apache.juneau.svl.SimpleVar

resolveTo

Methods inherited from class org.apache.juneau.svl.Var

allowNested, allowRecurse, canResolve, getName

Methods inherited from class java.lang.Object

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

Field Detail

SESSION_config

public static final String SESSION_config

The name of the session or context object that identifies the Config object.

See Also:

Constant Field Values

NAME

public static final String NAME

The name of this variable.

See Also:

Constant Field Values

Constructor Detail

ConfigVar

public ConfigVar()

Constructor.

Method Detail

resolve

public String resolve(VarResolverSession session,
                      String key)

Description copied from class: Var

The interface that needs to be implemented for subclasses of SimpleVar.

Specified by:

resolve in class Var

Parameters:

session - The session object used for a single instance of a var resolution.

key - The inside argument of the variable.

Returns:

The resolved value.