Package eu.bandm.music.entities

Class OrnamentUsage<O extends Ornament>

java.lang.Object

eu.bandm.music.entities.OrnamentUsage<O>

All Implemented Interfaces:

Cloneable

public class OrnamentUsage<O extends Ornament>
extends Object
implements Cloneable

Class reprenting the conventional usage of an ornaments = placing it at a notehead together with at most two additional accidentals, a lower and an upper one.

Field Summary

Fields

Modifier and Type	Field	Description
protected @Opt Accidental	lower	An optional accidental for the lower neighbour note of the main note.
protected O	ornament	The ornament symbol.
protected @Opt Accidental	upper	An optional accidental for the upper neighbour note of the main note, to use in the ornament's execution.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	OrnamentUsage(O ornament, @Opt Accidental lower, @Opt Accidental upper)	Only construtor, setting all parameters.

Method Summary

Modifier and Type	Method	Description
@Opt Accidental	get_lower()	Evident.
O	get_ornament()	Evident.
@Opt Accidental	get_upper()	Evident.
static Translet.Parser<OrnamentUsage>	getParser(Translet.Parser<Ornament> oparser, String sep)	Returns a parser for an ornament code with additional accidentals.
protected Ornament	with_lower(Accidental a)	Return a new clone with modified accidental.
protected Ornament	with_upper(Accidental a)	Return a new clone with modified accidental.

Methods inherited from class java.lang.Object

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

Field Details

ornament

protected O extends Ornament ornament

The ornament symbol.

upper

@Opt
protected @Opt Accidental upper

An optional accidental for the upper neighbour note of the main note, to use in the ornament's execution. Conventionally printed above the ornament symbol.

lower

@Opt
protected @Opt Accidental lower

An optional accidental for the lower neighbour note of the main note. to use in the ornament's execution. Conventionally printed above the ornament symbol.

Constructor Details

OrnamentUsage

protected OrnamentUsage(O ornament,
 @Opt
 @Opt Accidental lower,
 @Opt
 @Opt Accidental upper)

Only construtor, setting all parameters.

Method Details

get_ornament

public O get_ornament()

Evident.

get_lower

@Opt
public @Opt Accidental get_lower()

Evident.

get_upper

@Opt
public @Opt Accidental get_upper()

Evident.

with_lower

protected Ornament with_lower(Accidental a)

Return a new clone with modified accidental.

with_upper

protected Ornament with_upper(Accidental a)

Return a new clone with modified accidental.

getParser

public static Translet.Parser<OrnamentUsage> getParser(Translet.Parser<Ornament> oparser,
 String sep)

Returns a parser for an ornament code with additional accidentals. Its grammar is ornament lower? (SEP upper)?. As separator symbole SEP a slash »/« or a caret »^« seems sensible.