Package eu.bandm.music.entities

Class PitchAndOctave<O extends Entity & Comparable<O>,C extends Entity & PitchIndication & Comparable<C>>

java.lang.Object

eu.bandm.music.entities.PitchAndOctave<O,C>

All Implemented Interfaces:

PitchIndication, Comparable<PitchAndOctave<O,C>>

Direct Known Subclasses:

FunctionalPitch

public class PitchAndOctave<O extends Entity & Comparable<O>,C extends Entity & PitchIndication & Comparable<C>>
extends Object
implements PitchIndication, Comparable<PitchAndOctave<O,C>>

A pitch indication which combines some octave register information and some pitch class modulo octave.

Field Summary

Fields

Modifier and Type	Field	Description
protected C	classModOctave	The octave-relative coordinate (= "pitch class" = "pitch mod octave") of this pitch.
protected O	octave	The octave coordinate of this pitch.

Constructor Summary

Constructors

Constructor	Description
PitchAndOctave(O octave, C classModOctave)	Only constructor.

Method Summary

Modifier and Type	Method	Description
int	compareTo(PitchAndOctave<O,C> other)	Evident
boolean	equals(Object o)
C	get_classModOctave()	return the pitch class coordinate
O	get_octave()	Return the octave coordinate
String	getName(String lang)
String	getName(String lang, String sep)	Delivers the composed name, only in the given language.
static <OCT extends Entity & Comparable<OCT>, PC extends Entity & PitchIndication & Comparable<PC>> Translet.Parser<PitchAndOctave<OCT,PC>>	parser(Translet.Parser<PC> pc, Translet.Parser<OCT> oct)	Deliver a parser which combines both given parsers.
String	toString()
String	toString(String... langs)	Return text representation with the given language preferences.
static <OO extends Entity & Comparable<OO>, CC extends Entity & PitchIndication & Comparable<CC>> PitchAndOctave<OO,CC>	valueOf(OO octave, CC classModOctave)

Methods inherited from class java.lang.Object

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

Field Details

octave

protected O extends Entity & Comparable<O> octave

The octave coordinate of this pitch.

classModOctave

protected C extends Entity & PitchIndication & Comparable<C> classModOctave

The octave-relative coordinate (= "pitch class" = "pitch mod octave") of this pitch.

Constructor Details

PitchAndOctave

public PitchAndOctave(O octave,
 C classModOctave)

Only constructor.

Method Details

valueOf

public static <OO extends Entity & Comparable<OO>,
CC extends Entity & PitchIndication & Comparable<CC>>
PitchAndOctave<OO,CC> valueOf(OO octave,
 CC classModOctave)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

compareTo

public int compareTo(PitchAndOctave<O,C> other)

Evident

Specified by:

compareTo in interface Comparable<O extends Entity & Comparable<O>>

get_octave

public O get_octave()

Return the octave coordinate

get_classModOctave

public C get_classModOctave()

return the pitch class coordinate

toString

public String toString(String... langs)

Return text representation with the given language preferences.

toString

public String toString()

Overrides:

toString in class Object

getName

public String getName(String lang)

getName

public String getName(String lang,
 String sep)

Delivers the composed name, only in the given language.

parser

public static <OCT extends Entity & Comparable<OCT>,
PC extends Entity & PitchIndication & Comparable<PC>>
Translet.Parser<PitchAndOctave<OCT,PC>> parser(Translet.Parser<PC> pc,
 Translet.Parser<OCT> oct)

Deliver a parser which combines both given parsers.