Package com.emc.d2fs.utils
Class Parameters
java.lang.Object
com.emc.d2fs.utils.Parameters
Parameter object -- used in OpenAjax pub/sub event arguments.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
Replacement string for PARAM_EQ if found in the parameter valuestatic final String
Event message - Equals/Assignmentstatic final String
Event message - Separatorstatic final String
Replacement string for PARAM_SEPARATOR if found in the parameter value -
Constructor Summary
ConstructorsConstructorDescriptionParameters
(Parameters parametersToClone) Parameters
(String message) Parameters
(String... params) Parameters
(String paramKey, String paramValue) Creates a new parameters object with this key/value dataParameters
(String message, Map<String, Object> params) Parameters
(Map<String, String> params) -
Method Summary
Modifier and TypeMethodDescriptionvoid
addParameters
(Item item) Add parameters from item attributesvoid
addParameters
(Node node) Add parameters from node Attributesvoid
addParameters
(Parameters params) Add parametersvoid
addParameters
(Parameters params, boolean override) Add parametersvoid
addParameters
(List<Attribute> attributes) Add parametersvoid
addParameters
(Map<String, Object> properties) Add parametersstatic String
decodeParameterValue
(String paramValue) Decode parameter value from previously encoded characters If you value has been encoded using encodeParameterValue, you must use this method to convert back some character that may have been encodedstatic String
encodeParameterValue
(String paramValue) Encode parameter value to avoid parsing issue when specific character or character combination are present in the valueboolean
getParameter
(String parameterName) Get a parametergetParameter
(String parameterName, String defaultValue) Get a parameterboolean
getParameterBoolean
(String parameterName) Get a boolean valueboolean
getParameterBoolean
(String parameterName, boolean defaultValue) Get a boolean parameterboolean[]
getParameterBooleanMultiple
(String parameterName) Get a boolean array parameterint
getParameterInt
(String parameterName) Get an integer parameterint
getParameterInt
(String parameterName, int defaultValue) Get an integer parameterint[]
getParameterIntMultiple
(String parameterName) Get an integer array parameterGet all parameters.String[]
getParameters
(String parameterName) Get an array parameterboolean
hasParameter
(String parameterName) Determine if parameters exists.boolean
isParameterMultiple
(String parameterName) Determine if parameter has multiple valuesboolean
isValueInParameter
(String parameterName, String value, boolean returnTrueIParameterNull) removeParameter
(String parameterName) Remove parametersetParameter
(Attribute attribute) Set parameter (override it if already exists)setParameter
(String parameterName, boolean parameterValue) Set parameter (override it if already exists)setParameter
(String parameterName, boolean[] parameterValues) Set parameter (override it if already exists)setParameter
(String parameterName, int parameterValue) Set parameter (override it if already exists)setParameter
(String parameterName, int[] parameterValues) Set parameter (override it if already exists)setParameter
(String parameterName, String parameterValue) Set parameter (override it if already exists)setParameter
(String parameterName, String[] parameterValues) Set parameter (override it if already exists)setParameter
(String parameterName, String parameterValue, boolean override) Set parametersetParameter
(String parameterName, List<String> parameterValues) Set parameter (override it if already exists)boolean
setRawParameter
(String parameter) Set a parameter from parameter stringtoString()
Get all parameters as string
-
Field Details
-
SEP_ENCODED
Replacement string for PARAM_SEPARATOR if found in the parameter value- See Also:
-
EQ_ENCODED
Replacement string for PARAM_EQ if found in the parameter value- See Also:
-
PARAM_EQ
Event message - Equals/Assignment- See Also:
-
PARAM_SEPARATOR
Event message - Separator- See Also:
-
-
Constructor Details
-
Parameters
public Parameters() -
Parameters
- Parameters:
params
- a map of key/value that will be added
-
Parameters
Creates a new parameters object with this key/value data- Parameters:
paramKey
-paramValue
-
-
Parameters
- Parameters:
params
- : key1, value1, key2, value2, key3, value3... that will be added
-
Parameters
- Parameters:
message
- OpenAjaxHub string message that will be parsedparams
- a map of key/value that will be added- Throws:
ParseException
-
Parameters
- Parameters:
parametersToClone
- Parameters that will be cloned
-
Parameters
- Parameters:
message
- OpenAjaxHub string message that will be parsed- Throws:
ParseException
- if no equal separator is detected on one parameter, parameter must always be under the form of key==value or key== or key==null
-
-
Method Details
-
setParameter
Set parameter (override it if already exists)- Parameters:
parameterName
- Name of parameterparameterValue
- Value of parameter- Returns:
- this
-
setParameter
Set parameter (override it if already exists)- Parameters:
parameterName
- Name of parameterparameterValues
- Values of parameter an array of values- Returns:
- this
-
setParameter
Set parameter (override it if already exists)- Parameters:
parameterName
- Name of parameterparameterValues
- an list of values- Returns:
- this
-
setParameter
Set parameter (override it if already exists)- Parameters:
parameterName
- Name of parameterparameterValue
- integer value- Returns:
- this
-
setParameter
Set parameter (override it if already exists)- Parameters:
parameterName
- Name of parameterparameterValues
- an array of values- Returns:
- this
-
setParameter
Set parameter (override it if already exists)- Parameters:
parameterName
- Name of parameterparameterValue
- Value of parameter- Returns:
- this
-
setParameter
Set parameter (override it if already exists)- Parameters:
attribute
-- Returns:
- this
-
setParameter
Set parameter (override it if already exists)- Parameters:
parameterName
- Name of parameterparameterValues
- an array of values- Returns:
- this
-
setParameter
Set parameter- Parameters:
parameterName
- Name of parameterparameterValue
- Value of parameteroverride
- if true, the value will be overwritten if already existing- Returns:
- this
-
removeParameter
Remove parameter- Parameters:
parameterName
- Name of parameter- Returns:
- this
-
isParameterMultiple
Determine if parameter has multiple values- Parameters:
parameterName
- Name of parameter- Returns:
- true if the parameter has multiple values
-
setRawParameter
Set a parameter from parameter string- Parameters:
parameter
- "paramName1==paramValue1!!parameterName2==paramValue2"- Returns:
- true if the parameter to parse and setup is correct, if consecutive parameter separator is found it will return false
- Throws:
ParseException
- if no equal separator is detected on one parameter, parameter must always be under the form of key==value or key== or key==null
-
getParameter
Get a parameter- Parameters:
parameterName
- Name of parameter- Returns:
- the value of this parameter or null if this parameter does not exist
-
getParameters
Get an array parameter- Parameters:
parameterName
- Name of parameter- Returns:
- the values of this parameter or null if this parameter does not exist
-
getParameter
Get a parameter- Parameters:
parameterName
- Name of parameterdefaultValue
- value returned if the parameter is not found- Returns:
- the value of this parameter
-
decodeParameterValue
Decode parameter value from previously encoded characters If you value has been encoded using encodeParameterValue, you must use this method to convert back some character that may have been encoded- Parameters:
paramValue
-- Returns:
- decoded paramValue cleared of the special character encoded, so just the value you wanted
-
encodeParameterValue
Encode parameter value to avoid parsing issue when specific character or character combination are present in the value- Parameters:
paramValue
-- Returns:
- encoded paramValue free of the special character that could break the parsing
-
getParameterBoolean
Get a boolean value- Parameters:
parameterName
- Name of parameter- Returns:
- the boolean value
-
getParameterBooleanMultiple
Get a boolean array parameter- Parameters:
parameterName
- Name of parameter- Returns:
- the boolean values
-
getParameterBoolean
Get a boolean parameter- Parameters:
parameterName
- Name of parameterdefaultValue
- value returned if the parameter is not found or invalid- Returns:
- the boolean value
-
getParameterInt
Get an integer parameter- Parameters:
parameterName
- Parameter name- Returns:
- the integer value
-
getParameterIntMultiple
Get an integer array parameter- Parameters:
parameterName
- Name of parameter- Returns:
- the integer values
-
getParameterInt
Get an integer parameter- Parameters:
parameterName
- Name of parameterdefaultValue
- value returned if the parameter is not found or invalid- Returns:
- the integer value
-
isValueInParameter
public boolean isValueInParameter(String parameterName, String value, boolean returnTrueIParameterNull) - Parameters:
parameterName
- : the parameter to analyzevalue
- : the value to find in the parameterreturnTrueIParameterNull
- : if param or value is null, return true- Returns:
- true if the value in is the parameter ( single or multiple )
-
toString
Get all parameters as string -
addParameters
Add parameters- Parameters:
params
- Parameters object
-
addParameters
Add parameters- Parameters:
params
- Parameters objectoverride
- true to overwrite existing values
-
addParameters
Add parameters- Parameters:
attributes
- List of attributes
-
addParameters
Add parameters- Parameters:
properties
- Property map.
-
addParameters
Add parameters from item attributes- Parameters:
item
- D2FS Model item
-
addParameters
Add parameters from node Attributes- Parameters:
node
- D2FS Model node
-
getParameters
Get all parameters.- Returns:
- Map of parameters
-
hasParameter
Determine if parameters exists.- Parameters:
parameterName
- Name of Parameter- Returns:
- true if parameter exists
-
equals
-