org.vladnput
Class VladMessageVars

java.lang.Object
  extended by org.vladnput.VladMessageVars

public class VladMessageVars
extends java.lang.Object

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.

Author:
Patrick Higgins

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

PARAM_VAR

public static final java.lang.String PARAM_VAR
See Also:
Constant Field Values

PARAM_DESC_VAR

public static final java.lang.String PARAM_DESC_VAR
See Also:
Constant Field Values

VALUE_VAR

public static final java.lang.String VALUE_VAR
See Also:
Constant Field Values

URI

public static final java.lang.String URI
See Also:
Constant Field Values
Constructor Detail

VladMessageVars

public VladMessageVars(java.lang.String path)
Method Detail

registerVar

public 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}.

Parameters:
var - Variable name

registerVars

public static void registerVars(java.util.Collection<java.lang.String> vars)
A bulk version of registerVar(String) for a collection of String variable names.

Parameters:
vars - Variable names

isValidVar

public static boolean isValidVar(java.lang.String key)
Returns true if key is a valid variable name, false otherwise.

Parameters:
key - Variable name
Returns:
true if key is a valid variable name, false otherwise

get

public java.lang.String get(java.lang.String var)
Gets the value of the variable named var.

Parameters:
var - Message variable name
Returns:
Message variable value

put

public void put(java.lang.String var,
                java.lang.String value)
Sets the value of the variable named var to value.

Parameters:
var - Message variable name
value - Message variable value

remove

public void remove(java.lang.String var)
Unsets the value of the variable named var.

Parameters:
var - Message variable name


Copyright © 2009 Patrick Higgins. All Rights Reserved.