|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.vladnput.VladMessageVars
public class VladMessageVars
Class that acts as a registry of all the variable names that may appear in a message. The ${param}, ${param_desc}, ${value}, and ${uri} values are always defined. More variables are defined by individual types. Instances of this class hold the values of variables that are to be interpolated into a message.
Field Summary | |
---|---|
static java.lang.String |
PARAM_DESC_VAR
|
static java.lang.String |
PARAM_VAR
|
static java.lang.String |
URI
|
static java.lang.String |
VALUE_VAR
|
Constructor Summary | |
---|---|
VladMessageVars(java.lang.String path)
|
Method Summary | |
---|---|
java.lang.String |
get(java.lang.String var)
Gets the value of the variable named var. |
static boolean |
isValidVar(java.lang.String key)
Returns true if key is a valid variable name, false otherwise. |
void |
put(java.lang.String var,
java.lang.String value)
Sets the value of the variable named var to value. |
static void |
registerVar(java.lang.String var)
Registers the variable named var as a valid variable name that may appear inside a message body as ${var}. |
static void |
registerVars(java.util.Collection<java.lang.String> vars)
A bulk version of registerVar(String) for a collection of String variable names. |
void |
remove(java.lang.String var)
Unsets the value of the variable named var. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String PARAM_VAR
public static final java.lang.String PARAM_DESC_VAR
public static final java.lang.String VALUE_VAR
public static final java.lang.String URI
Constructor Detail |
---|
public VladMessageVars(java.lang.String path)
Method Detail |
---|
public static void registerVar(java.lang.String var)
var
- Variable namepublic static void registerVars(java.util.Collection<java.lang.String> vars)
vars
- Variable namespublic static boolean isValidVar(java.lang.String key)
key
- Variable name
public java.lang.String get(java.lang.String var)
var
- Message variable name
public void put(java.lang.String var, java.lang.String value)
var
- Message variable namevalue
- Message variable valuepublic void remove(java.lang.String var)
var
- Message variable name
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |