org.midica.file.read

Class CommandOption

java.lang.Object

org.midica.file.read.CommandOption

public class CommandOption
extends java.lang.Object

Objects of this class represent a MidicaPL command option. It can be:

• a channel option
• an option for a CALL command
• an outer option for a pattern call command
• an inner option for a pattern line
• an option for an opening or closing brace of a nestable block
• an option in a compact syntax string

Author:

Jan Trukenmüller

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	name
private java.lang.String	rawName
private java.lang.String	rawValue
private java.lang.Object	value

Constructor Summary

Constructors

Constructor and Description
CommandOption()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCondition() Returns a condition for an if or elsif option.
java.lang.Float	getDuration() Returns the duration.
java.lang.String	getLength() Returns the note length.
java.lang.String	getLyrics() Returns a lyrics syllable.
java.lang.String	getName() Returns the (unified) option name.
java.lang.Integer	getQuantity() Returns the quantity.
java.lang.String	getRawName() Returns the raw name, like it is used in MidicaPL syntax.
java.lang.String	getRawValue() Returns the string representation of the value, if avaliable, or null otherwise.
int	getShift() Returns a shift modifier.
int	getTremolo() Returns a tremolo modifier.
java.lang.String	getTuplet() Returns a tuplet modifier.
java.lang.Integer	getVelocity() Returns the velocity.
void	set(java.lang.String name, java.lang.Object value, java.lang.String rawName, java.lang.String rawValue) Initializes the option with a name and a value.

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.Object value

rawName

private java.lang.String rawName

rawValue

private java.lang.String rawValue

Constructor Detail

CommandOption

public CommandOption()

Method Detail

set

public void set(java.lang.String name,
                java.lang.Object value,
                java.lang.String rawName,
                java.lang.String rawValue)
         throws ParseException

Initializes the option with a name and a value.

Parameters:

name - Option name in a canonized form, independent from the current syntax configuration.

value - Option value.

rawName - Option name according to the current syntax configuration.

rawValue - Option value as a string, according to the current MidicaPL configuration.

Throws:

ParseException - if the given name is invalid.

getRawName

public java.lang.String getRawName()

Returns the raw name, like it is used in MidicaPL syntax.

Returns:

the raw name.

getName

public java.lang.String getName()

Returns the (unified) option name.

Returns:

option name.

getRawValue

public java.lang.String getRawValue()

Returns the string representation of the value, if avaliable, or null otherwise.

Returns:

the string representation of the value or null.

getQuantity

public java.lang.Integer getQuantity()

Returns the quantity.

Returns:

quantity.

getLength

public java.lang.String getLength()

Returns the note length.

Returns:

note length.

getVelocity

public java.lang.Integer getVelocity()

Returns the velocity.

Returns:

velocity.

getDuration

public java.lang.Float getDuration()

Returns the duration.

Returns:

duration.

getLyrics

public java.lang.String getLyrics()

Returns a lyrics syllable.

Returns:

lyrics syllable.

getTuplet

public java.lang.String getTuplet()

Returns a tuplet modifier.

Returns:

tuplet modifier.

getTremolo

public int getTremolo()

Returns a tremolo modifier.

Returns:

tremolo modifier.

getShift

public int getShift()

Returns a shift modifier.

Returns:

shift modifier.

getCondition

public java.lang.String getCondition()

Returns a condition for an if or elsif option.

Returns:

condition.