jlscp
v0.8

org.linuxsampler.lscp
Class StringListParameter

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

public class StringListParameter
extends AbstractParameter<java.lang.String[]>

This class implements the Parameter<String[]> interface.


Constructor Summary
  StringListParameter()
          Creates a new instance of StringListParameter
  StringListParameter(java.lang.String name)
          Creates a StringListParameter instance with the specified name.
protected StringListParameter(java.lang.String[] lnS)
          Creates a new instance of StringListParameter and parses the specified lines.
  StringListParameter(java.lang.String name, java.lang.String[] value)
          Creates a StringListParameter 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)
          Parses the specified character string and sets the value of this parameter with the parsed result.
 
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

StringListParameter

public StringListParameter()
Creates a new instance of StringListParameter


StringListParameter

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

Parameters:
name - The parameter name.

StringListParameter

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

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

StringListParameter

protected StringListParameter(java.lang.String[] lnS)
                       throws LscpException
Creates a new instance of StringListParameter 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
Parses the specified character string and sets the value of this parameter with the parsed result.

Parameters:
s - A character string containing the value to be parsed.
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.