Package com.tagtraum.audiokern.timesignature

Class TimeSignature

java.lang.Object

com.tagtraum.audiokern.timesignature.TimeSignature

All Implemented Interfaces:

Externalizable, Serializable, Cloneable, org.json.simple.JSONAware

public class TimeSignature
extends Object
implements Externalizable, org.json.simple.JSONAware, Cloneable

Time signature. E.g. 3/4 for a waltz.

Author:

Hendrik Schreiber

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
TimeSignature()
TimeSignature(int numerator, int denominator)	Time signature.
TimeSignature(String jsonString)	Instantiate from JSON string.

Method Summary

Modifier and Type	Method	Description
Object	clone()
boolean	equals(Object o)
int	getDenominator()	The denominator of the time signature also known as "beat unit" or "note value of one beat", i.e.
static TimeSignature	getInstance(int numerator, int denominator)	Create or re-use a time signature instance.
int	getNumerator()	The numerator of the time signature also known as "beats per bar", i.e.
int	hashCode()
void	readExternal(ObjectInput in)
void	setDenominator(int denominator)	Sets the denominator of the time signature
void	setNumerator(int numerator)	Sets the numerator of the time signature.
String	toJSONString()
String	toString()
void	writeExternal(ObjectOutput out)

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TimeSignature

public TimeSignature(int numerator,
                     int denominator)

Time signature.

Parameters:

numerator - numerator

denominator - denominator

TimeSignature

public TimeSignature()

TimeSignature

public TimeSignature(String jsonString)

Instantiate from JSON string.

Parameters:

jsonString - data string

See Also:

toJSONString()

Method Detail

getInstance

public static TimeSignature getInstance(int numerator,
                                        int denominator)

Create or re-use a time signature instance.

Parameters:

numerator - numerator

denominator - denominator

Returns:

instance

getNumerator

public int getNumerator()

The numerator of the time signature also known as "beats per bar", i.e. for a waltz in 3/4 time this method would return a 3.

Returns:

meter numerator

See Also:

setNumerator(int)

setNumerator

public void setNumerator(int numerator)
                  throws IllegalArgumentException

Sets the numerator of the time signature.

Parameters:

numerator - meter numerator

Throws:

IllegalArgumentException - if the value is less than 1

See Also:

getNumerator()

getDenominator

public int getDenominator()

The denominator of the time signature also known as "beat unit" or "note value of one beat", i.e. for a waltz in 3/4 time this method would return a 4.

Returns:

meter denominator

setDenominator

public void setDenominator(int denominator)
                    throws IllegalArgumentException

Sets the denominator of the time signature

Parameters:

denominator - meter denominator

Throws:

IllegalArgumentException - if the value is less than 1

See Also:

getDenominator()

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException

toJSONString

public String toJSONString()

Specified by:

toJSONString in interface org.json.simple.JSONAware

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

clone

public Object clone()
             throws CloneNotSupportedException

Overrides:

clone in class Object

Throws:

CloneNotSupportedException