org.apache.juneau.svl

Class VarResolverSession

java.lang.Object

org.apache.juneau.svl.VarResolverSession

public class VarResolverSession
extends Object

A var resolver session that combines a VarResolver with one or more session objects.

Instances of this class are considered light-weight and fast to construct, use, and discard.

This class contains the workhorse code for var resolution.

Instances of this class are created through the VarResolver.createSession() and VarResolver.createSession(Map) methods.

Instances of this class are NOT guaranteed to be thread safe.

See Also:

• Overview > juneau-svl > VarResolvers and VarResolverSessions

Constructor Summary

Constructors

Constructor and Description
VarResolverSession(VarResolverContext context, Map<String,Object> sessionObjects) Constructor.

Method Summary

Modifier and Type	Method and Description
<T> T	getSessionObject(Class<T> c, String name) Returns the session object with the specified name.
protected Var	getVar(String name) Returns the Var with the specified name.
String	resolve(String s) Resolve all variables in the specified string.
<T> T	resolve(T o) Convenience method for resolving variables in arbitrary objects.
Writer	resolveTo(String s, Writer out) Resolves variables in the specified string and sends the output to the specified writer.
VarResolverSession	sessionObject(String name, Object o) Adds a session object to this session.

Methods inherited from class java.lang.Object

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

Constructor Detail

VarResolverSession

public VarResolverSession(VarResolverContext context,
                          Map<String,Object> sessionObjects)

Constructor.

Parameters:

context - The VarResolver context object that contains the Vars and context objects associated with that resolver.

sessionObjects - The session objects.

Method Detail

sessionObject

public VarResolverSession sessionObject(String name,
                                        Object o)

Adds a session object to this session.

Parameters:

name - The name of the session object.

o - The session object.

Returns:

This method (for method chaining).

resolve

public String resolve(String s)

Resolve all variables in the specified string.

Parameters:

s - The string to resolve variables in.

Returns:

The new string with all variables resolved, or the same string if no variables were found.
Returns null if the input was null.

resolve

public <T> T resolve(T o)

Convenience method for resolving variables in arbitrary objects.

Supports resolving variables in the following object types:

• CharSequence
• Arrays containing values of type CharSequence.
• Collections containing values of type CharSequence.
  Collection class must have a no-arg constructor.
• Maps containing values of type CharSequence.
  Map class must have a no-arg constructor.

Parameters:

o - The object.

Returns:

The same object if no resolution was needed, otherwise a new object or data structure if resolution was needed.

resolveTo

public Writer resolveTo(String s,
                        Writer out)
                 throws IOException

Resolves variables in the specified string and sends the output to the specified writer.

More efficient than first parsing to a string and then serializing to the writer since this method doesn't need to construct a large string.

Parameters:

s - The string to resolve variables in.

out - The writer to write to.

Returns:

The same writer.

Throws:

IOException

getSessionObject

public <T> T getSessionObject(Class<T> c,
                              String name)

Returns the session object with the specified name.

Casts it to the specified class type for you.

Parameters:

c - The class type to cast to.

name - The name of the session object.

Returns:

The session object.
Never null.

Throws:

RuntimeException - If session object with specified name does not exist.

getVar

protected Var getVar(String name)

Returns the Var with the specified name.

Parameters:

name - The var name (e.g. "S").

Returns:

The Var instance, or null if no Var is associated with the specified name.