public static class LabelPrinter.VarDictionary
extends java.lang.Object
Note: If the label definition in the commands and attributes JSON object
specifies the VarPrefix
and/or the VarPostfix
settings, the prefix and/or the postfix will be added to form the complete
variable name before the variable substitution logic is applied.
Constructor and Description |
---|
LabelPrinter.VarDictionary()
Constructs a new VarDictionary object.
|
Modifier and Type | Method and Description |
---|---|
void |
clear()
Clears the dictionary entries contained in this object.
|
boolean |
containsVarName(java.lang.String varName)
Returns true if this object contains the specified variable name.
|
boolean |
containsVarValue(java.lang.String varValue)
Returns true if this object contains the specified variable value.
|
java.util.Set |
entrySet()
Returns the dictionary entries contained in this object.
|
java.lang.String |
get(java.lang.String aVarName)
Gets the variable value of the specified variable name.
|
void |
put(java.lang.String aVarName,
java.lang.String aVarValue)
Add a new entry to the dictionary with the specified variable name and value.
|
void |
remove(java.lang.String aVarName)
Removes the specified variable name from the dictionary entries.
|
public LabelPrinter.VarDictionary()
public void clear()
public boolean containsVarName(java.lang.String varName)
varName
- A variable name to search for.public boolean containsVarValue(java.lang.String varValue)
varValue
- A variable value to search for.public java.util.Set entrySet()
Map.Entry
object.public java.lang.String get(java.lang.String aVarName)
aVarName
- A variable name.public void put(java.lang.String aVarName, java.lang.String aVarValue) throws LabelPrinterException
Note: The variable name should not contain prefix or postfix. If the label
definition in the commands and attributes JSON object specifies the
VarPrefix
and/or the VarPostfix
settings, the
prefix and/or the postfix will be added to form the complete variable name
before the variable substitution logic is applied.
aVarName
- A variable name to add.aVarValue
- A variable value to add.LabelPrinterException
- if the parameter values are invalid.public void remove(java.lang.String aVarName)
aVarName
- A variable name to remove.Copyright (c) 2013-2015 Honeywell International Inc. All rights reserved.