Class VCParameter
- java.lang.Object
-
- de.uplanet.lucy.server.auxiliaries.VCParameter
-
@VelocityVariable("Parameter") @VelocityCallable("instance") public final class VCParameter extends Object
-
-
Constructor Summary
Constructors Constructor Description VCParameter(IBinding p_binding)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
containsParameter(String p_parameterName)
IIxValue
get(String p_parameterName)
Returns the parameter value.IIxValue
get(String p_parameterName, Object p_default)
Returns the parameter value.String
getAsString(String p_parameterName)
Returns the parameter value as an string.String
getAsString(String p_parameterName, String p_default)
Returns the parameter value as an string.boolean
has(String p_parameterName)
-
-
-
Constructor Detail
-
VCParameter
public VCParameter(IBinding p_binding)
-
-
Method Detail
-
has
public boolean has(String p_parameterName)
- Parameters:
p_parameterName
- The parameter name- Returns:
- Returns
true
if a page parameter with the name exists and a value is set.
-
containsParameter
public boolean containsParameter(String p_parameterName)
- Parameters:
p_parameterName
- The parameter name- Returns:
- Returns
true
if a page parameter with the name exists and a value is set.
-
get
public IIxValue get(String p_parameterName)
Returns the parameter value.- Parameters:
p_parameterName
- The parameter name- Returns:
- Returns the maybe empty value of the parameter, never
null
.
-
get
public IIxValue get(String p_parameterName, Object p_default)
Returns the parameter value.- Parameters:
p_parameterName
- The parameter namep_default
- The default value, returned if parameter value has no value.- Returns:
- Returns the value of the parameter. If no parameter value found the default value will returned.
(if defaultValue is
null
thennull
will returned otherwiseIxValueFactory.create(p_default)
will returned).
-
getAsString
public String getAsString(String p_parameterName)
Returns the parameter value as an string. @seeIIxValue.asString()
- Parameters:
p_parameterName
- The parameter name- Returns:
- Returns the parameter value as an string or
null
if parameter value is not set.
-
getAsString
public String getAsString(String p_parameterName, String p_default)
Returns the parameter value as an string. @seeIIxValue.asString()
- Parameters:
p_parameterName
- The parameter namep_default
- The default value- Returns:
- Returns the parameter value as an string or the default value if the parameter value is not set.
-
-