Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> fluidsynth >> api >> [ settings overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

org.fluidsynth.api.settings
Class Setting  

java.lang.Object
  org.fluidsynth.api.settings.Setting

Direct Known Subclasses:

AbstractNumberSetting, BooleanSetting, OptionSetting, StringSetting

---

public abstract class Setting

extends java.lang.Object

Base class for objects which represent a fluidsynth setting.

---

Field Summary
private  java.lang.String	commandLineOption
private  java.lang.String	defaultValue
private  boolean	isRealtime
private  java.lang.String	name
private  java.lang.String	realtime
private  Settings	settings
private  java.lang.String	value

 

Constructor Summary

Setting()

 

Method Summary
java.lang.String	commandLineArg()           Return the command line argument used to communicate the current value of this setting to fluidsynth.
protected  void	dirty()           Set the dirty state of our parent Settings object.
java.lang.String	getCommandLineOption()           Set the command line option used to set this setting on the synth command line.
java.lang.String	getDefaultValue()           Get the default value of this setting.
java.lang.String	getName()           Get the name of this setting.
java.lang.String	getRealtime()           Get the realtime flag of this setting.
java.lang.String	getValue()           Get the current value of this setting.
boolean	isRealtime()           Get the realtime flag of this setting.
(package private)  boolean	isUserModified()           Returns true of the current value is different than the default value.
void	merge(Setting other)           Merge another setting into this one.
abstract  java.lang.Object	objectGet()           Returns an object which represents the current value as a java object.
abstract  void	objectSet(java.lang.Object value)           Given a java object, set the value of this option.
void	setCommandLineOption(java.lang.String option)           Set the command line option used to set this setting on the synth command line.
void	setDefaultValue(java.lang.String defaultValue)           Set the default value of this setting.
void	setName(java.lang.String name)           Set the name of this setting.
void	setRealtime(java.lang.String realtime)           Set the realtime flag of this setting.
void	setSettings(Settings settings)           Associate this setting to a Settings instance.
void	setValue(java.lang.String value)           Set the current value of this setting.
abstract  java.lang.Object	validate(java.lang.Object value)           Validates the value and if valid, returns it unaltered.

 

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Field Detail

name

private java.lang.String name

---

value

private java.lang.String value

---

commandLineOption

private java.lang.String commandLineOption

---

realtime

private java.lang.String realtime

---

defaultValue

private java.lang.String defaultValue

---

isRealtime

private boolean isRealtime

---

settings

private Settings settings

Constructor Detail

Setting

public Setting()

Method Detail

setSettings

public void setSettings(Settings settings)

Associate this setting to a Settings instance.

---

dirty

protected void dirty()

Set the dirty state of our parent Settings object.

---

merge

public void merge(Setting other)

Merge another setting into this one.

---

getName

public java.lang.String getName()

Get the name of this setting.

---

setName

public void setName(java.lang.String name)

Set the name of this setting.

---

getDefaultValue

public java.lang.String getDefaultValue()

Get the default value of this setting.

---

setDefaultValue

public void setDefaultValue(java.lang.String defaultValue)

Set the default value of this setting.

---

getValue

public java.lang.String getValue()

Get the current value of this setting.

---

setValue

public void setValue(java.lang.String value)

Set the current value of this setting.

---

setRealtime

public void setRealtime(java.lang.String realtime)

Set the realtime flag of this setting.

---

getRealtime

public java.lang.String getRealtime()

Get the realtime flag of this setting.

---

isRealtime

public boolean isRealtime()

Get the realtime flag of this setting.

---

setCommandLineOption

public void setCommandLineOption(java.lang.String option)

Set the command line option used to set this setting on the synth command line. E.g., the audio.driver setting has a command line option of "--audio.driver"

---

getCommandLineOption

public java.lang.String getCommandLineOption()

Set the command line option used to set this setting on the synth command line. E.g., the audio.driver setting has a command line option of "--audio.driver"

---

commandLineArg

public java.lang.String commandLineArg()

Return the command line argument used to communicate the current value of this setting to fluidsynth. E.g., when the value of the audio.driver setting is "alsa", this method returns --audio-driver=alsa.

---

isUserModified

boolean isUserModified()

Returns true of the current value is different than the default value.

---

objectGet

public abstract java.lang.Object objectGet()

Returns an object which represents the current value as a java object. For example, a BooleanSetting.objectGet() returns a java.lang.Boolean, IntegerSetting.objectGet() returns a java.lang.Integer, etc.

---

objectSet

public abstract void objectSet(java.lang.Object value)
                        throws java.lang.IllegalArgumentException

Given a java object, set the value of this option.

---

validate

public abstract java.lang.Object validate(java.lang.Object value)
                                   throws java.lang.IllegalArgumentException

Validates the value and if valid, returns it unaltered. Throws IllegalArgumentException if the object is not valid.

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> fluidsynth >> api >> [ settings overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---