org.apache.juneau.rest.vars

Class LocalizationVar

java.lang.Object

org.apache.juneau.svl.Var

org.apache.juneau.svl.SimpleVar

org.apache.juneau.svl.MultipartVar

org.apache.juneau.rest.vars.LocalizationVar

public class LocalizationVar
extends MultipartVar

Localized string variable resolver.

The format for this var is "$L{key[,args...]}".

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

Values are pulled from the RestRequest.getMessage(String,Object[]) method. These in turn are pulled from the resource bundle associated with the servlet class where the request was made.

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-rest-server > SVL Variables

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME The name of this variable.

Constructor Summary

Constructors

Constructor and Description
LocalizationVar() Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	canResolve(VarResolverSession session) Returns true if this variable can be resolved in the specified session.
String	resolve(VarResolverSession session, String[] args) The interface that needs to be implemented for this interface.

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

resolve

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

resolveTo

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

allowNested, allowRecurse, doResolve, getName

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final String NAME

The name of this variable.

See Also:

Constant Field Values

Constructor Detail

LocalizationVar

public LocalizationVar()

Constructor.

Method Detail

resolve

public String resolve(VarResolverSession session,
                      String[] args)

Description copied from class: MultipartVar

The interface that needs to be implemented for this interface.

Specified by:

resolve in class MultipartVar

Parameters:

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

args - The arguments inside the variable.

Returns:

The resolved variable.

canResolve

public boolean canResolve(VarResolverSession session)

Description copied from class: Var

Returns true if this variable can be resolved in the specified session.

For example, some variable cannot resolve unless specific context or session objects are available.

Overrides:

canResolve in class Var

Parameters:

session - The current session.

Returns:

true if this variable can be resolved in the specified session.