org.jvoicexml.documentserver

Class VariableEncoder

java.lang.Object

org.jvoicexml.documentserver.VariableEncoder

public final class VariableEncoder
extends java.lang.Object

Convenient class to access variables from a given URI or add variables to it to send them back to the DocumentServer.

Variables are appended to the given URI like the query string in a URL.

See Also:

DocumentServer, URL.getQuery()

Constructor Summary

Constructors

Constructor and Description
VariableEncoder(java.net.URI uri) Construct a new object.

Method Summary

Modifier and Type	Method and Description
void	add(java.lang.String name, java.lang.String value) Adds a variable with the given name and value.
java.net.URI	getBaseUri() Get the base URI without any parameters.
java.util.Map<java.lang.String,java.lang.String>	getVariables() Gets the currently defined variables and their values.
java.net.URI	toUri() Gets an encoded URI, consisting of the base URI, and assigned variables.

Methods inherited from class java.lang.Object

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

Constructor Detail

VariableEncoder

public VariableEncoder(java.net.URI uri)

Construct a new object.

Parameters:

uri - The base URI for encoding/decoding variables.

Method Detail

getVariables

public java.util.Map<java.lang.String,java.lang.String> getVariables()

Gets the currently defined variables and their values.

Returns:

Map of variable names and their values.

add

public void add(java.lang.String name,
                java.lang.String value)

Adds a variable with the given name and value.

Parameters:

name - Name of the new variable.

value - Value of the variable.

toUri

public java.net.URI toUri()

Gets an encoded URI, consisting of the base URI, and assigned variables. Use getBaseUri() to retrieve the URI without any variables.

Returns:

URI with variables.

See Also:

getBaseUri()

getBaseUri

public java.net.URI getBaseUri()

Get the base URI without any parameters. Use toUri() to retrieve the URI with assigned variables.

Returns:

Base URI without variables.

See Also:

toUri()