[]
        
(Showing Draft Content)

CSJ2K.j2k.util.ParameterList.getBooleanParameter

getBooleanParameter Method

getBooleanParameter(string)

Returns the value of the named parameter as a boolean. The value "on" is interpreted as 'true', while the value "off" is interpreted as 'false'. If the parameter has another value then an StringFormatException is thrown. If the parameter 'pname' is not in the parameter list, an IllegalArgumentException is thrown.

Declaration
public virtual bool getBooleanParameter(string pname)
Parameters
Type Name Description
string pname

The parameter name.

Returns
Type Description
bool

the value of the parameter as a boolean.

Exceptions
Type Condition
StringFormatException

If the parameter has a value which is neither "on" nor "off".