Package org.apache.juneau.rest.vars

Class UrlEncodeVar

java.lang.Object

org.apache.juneau.svl.Var

org.apache.juneau.svl.SimpleVar

org.apache.juneau.rest.vars.UrlEncodeVar

public class UrlEncodeVar
extends SimpleVar

URL-encoding variable resolver.

The format for this var is "$UE{uriPart}".

This variable takes the contents inside the variable and replaces it with a value returned by calling StringUtils.urlEncode(String)).

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.

See Also:

• SVL Variables

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
UrlEncodeVar()	Constructor.

Method Summary

Modifier and Type	Method	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.SimpleVar

resolveTo

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

allowNested, allowRecurse, canResolve, doResolve, getName

Methods inherited from class java.lang.Object

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

Field Details

NAME

public static final String NAME

The name of this variable.

See Also:

• Constant Field Values

Constructor Details

UrlEncodeVar

public UrlEncodeVar()

Constructor.

Method Details

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.