jlscp
v0.8

org.linuxsampler.lscp
Class StringParameter

java.lang.Object
  extended by org.linuxsampler.lscp.AbstractParameter<java.lang.String>
      extended by org.linuxsampler.lscp.StringParameter
All Implemented Interfaces:
Parameter<java.lang.String>, Parseable

public class StringParameter
extends AbstractParameter<java.lang.String>

This class implements the Parameter<String> interface.


Constructor Summary
  StringParameter()
          Creates a new instance of StringParameter
  StringParameter(java.lang.String name)
          Creates a StringParameter instance with the specified name.
protected StringParameter(java.lang.String[] lnS)
          Creates a new instance of StringParameter and parses the specified lines.
  StringParameter(java.lang.String name, java.lang.String value)
          Creates a StringParameter instance with the specified name and value.
 
Method Summary
 java.lang.String getStringValue()
          Gets the current value of this parameter.
 boolean parse(java.lang.String s)
          Parses a line of text.
 void parseValue(java.lang.String s)
          Sets the current value of this parameter with the specified character string.
 
Methods inherited from class org.linuxsampler.lscp.AbstractParameter
getDefault, getDependances, getDescription, getName, getPossibilities, getRangeMax, getRangeMin, getType, getValue, hasDependances, hasPossibilities, hasRangeMax, hasRangeMin, isBoolean, isBooleanList, isFixed, isFloat, isFloatList, isInteger, isIntegerList, isMandatory, isMultiplicity, isString, isStringList, parseLines, setDefault, setDescription, setMultiplicity, setName, setPossibilities, setRangeMax, setRangeMin, setType, setValue, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

StringParameter

public StringParameter()
Creates a new instance of StringParameter


StringParameter

public StringParameter(java.lang.String name)
Creates a StringParameter instance with the specified name.

Parameters:
name - The parameter name.

StringParameter

public StringParameter(java.lang.String name,
                       java.lang.String value)
Creates a StringParameter instance with the specified name and value.

Parameters:
name - The parameter name.
value - The parameter value.

StringParameter

protected StringParameter(java.lang.String[] lnS)
                   throws LscpException
Creates a new instance of StringParameter and parses the specified lines.

Parameters:
lnS - A String array with lines to be parsed.
Throws:
LscpException - If the parse fail.
Method Detail

parse

public boolean parse(java.lang.String s)
              throws LscpException
Parses a line of text.

Specified by:
parse in interface Parseable
Overrides:
parse in class AbstractParameter<java.lang.String>
Parameters:
s - The string to be parsed.
Returns:
true if the line has been processed, false otherwise.
Throws:
LscpException - If some error occurs.

parseValue

public void parseValue(java.lang.String s)
                throws LscpException
Sets the current value of this parameter with the specified character string.

Parameters:
s - The new value for this parameter.
Throws:
LscpException - If the parsing failed.

getStringValue

public java.lang.String getStringValue()
Gets the current value of this parameter.

Returns:
The current value of this parameter.

jlscp
v0.8

Copyright © 2009 Grigor Iliev. All rights reserved.