stanford.cs106.audio

Class Note

java.lang.Object

stanford.cs106.audio.Note

public class Note
extends Object

This instructor-provided file represents musical notes and is to be used by your Melody class. Each Note object represents a musical note or rest. A Note encapsulates a pitch (A-G), a duration in seconds, an octave, an accidental (sharp, flat, or natural), and a flag of whether it is the start/end of a repeated section or not. A song or melody can be thought of as a list or array of Note objects.

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEBUG
static int	OCTAVE_MAX Constant for the maximum legal value that an octave can have.
static int	OCTAVE_MIN Constant for the minimum legal value that an octave can have.

Constructor Summary

Constructors

Constructor and Description
Note(double duration, boolean repeat) Constructs a new rest (Pitch.R) of the given duration.
Note(double duration, Pitch pitch, int octave, Accidental accidental, boolean repeat) Constructs a Note with the given information.
Note(double duration, String pitch, int octave, String accidental, boolean repeat) Constructs a Note with the given information.
Note(String line) Constructs a Note with the information contained in the given line.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o) Returns true if o refers to a Note object with the same state as this Note object; otherwise false.
Accidental	getAccidental() Returns this Note's accidental value of SHARP, FLAT, or NATURAL.
double	getDuration() Returns this Note's duration in seconds.
int	getOctave() Returns this Note's octave.
Pitch	getPitch() Returns this Note's pitch value of A-G or R for a rest.
boolean	isRepeat() Returns true if this Note is the start or end of a repeated section.
boolean	isRest() Returns true if this Note is a rest.
void	play() Plays this note through the underlying audio system.
void	setAccidental(Accidental accidental) Sets this Note's accidental value to be the given value: SHARP, FLAT, or NATURAL.
void	setAccidental(String accidental) Sets this Note's accidental value to be the given value: "SHARP", "FLAT", or "NATURAL".
void	setDuration(double duration) Sets this Note's duration in seconds to be the given value.
void	setOctave(int octave) Sets this Note's octave to be the given value.
void	setPitch(Pitch pitch) Sets this Note's pitch to be the given value.
void	setPitch(String pitch) Sets this Note's pitch to be the given value.
void	setRepeat(boolean repeat) Sets this Note's repeat flag to be the given value.
String	toString() Returns a string representation of this note.

Methods inherited from class java.lang.Object

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

Field Detail

OCTAVE_MIN

public static final int OCTAVE_MIN

Constant for the minimum legal value that an octave can have.

See Also:

Constant Field Values

OCTAVE_MAX

public static final int OCTAVE_MAX

Constant for the maximum legal value that an octave can have.

See Also:

Constant Field Values

DEBUG

public static boolean DEBUG

Constructor Detail

Note

public Note(String line)

Constructs a Note with the information contained in the given line.

Parameters:

line - a line of input data such as "0.2 C 4 NATURAL false" or "0.4 R false" for a rest

Throws:

NullPointerException - if line is null.

IllegalArgumentException - if duration is negative or octave is not between OCTAVE_MIN and OCTAVE_MAX inclusive.

Note

public Note(double duration,
            Pitch pitch,
            int octave,
            Accidental accidental,
            boolean repeat)

Constructs a Note with the given information.

Parameters:

duration - Note's duration in seconds.

pitch - Note's pitch from Pitch.A through Pitch.G, or Pitch.R for a rest.

octave - Note's octave from OCTAVE_MIN through OCTAVE_MAX inclusive.

accidental - Note's accidental from Accidental.SHARP, FLAT, or NATURAL.

repeat - true if this note starts/ends a repeated section.

Throws:

NullPointerException - if pitch or accidental is null.

IllegalArgumentException - if duration is negative or octave is not between OCTAVE_MIN and OCTAVE_MAX inclusive.

Note

public Note(double duration,
            String pitch,
            int octave,
            String accidental,
            boolean repeat)

Constructs a Note with the given information.

Parameters:

duration - Note's duration in seconds.

pitch - Note's pitch from "A" through "G", or "R" for a rest.

octave - Note's octave from OCTAVE_MIN through OCTAVE_MAX inclusive.

accidental - Note's accidental from "SHARP", "FLAT", or "NATURAL".

repeat - true if this note starts/ends a repeated section.

Throws:

NullPointerException - if pitch or accidental is null.

IllegalArgumentException - if duration is negative or octave is not between OCTAVE_MIN and OCTAVE_MAX inclusive.

Note

public Note(double duration,
            boolean repeat)

Constructs a new rest (Pitch.R) of the given duration.

Parameters:

duration - Note's duration in seconds.

repeat - true if this rest starts/ends a repeated section.

Throws:

NullPointerException - if accidental is null.

IllegalArgumentException - if duration is negative.

Method Detail

equals

public boolean equals(Object o)

Returns true if o refers to a Note object with the same state as this Note object; otherwise false.

Overrides:

equals in class Object

Parameters:

o - the object to compare against

Returns:

true if o refers to a Note object with the same state as this Note object; otherwise false.

getAccidental

public Accidental getAccidental()

Returns this Note's accidental value of SHARP, FLAT, or NATURAL. The accidental value is meaningless for a rest; this method will return Accidental.NATURAL by default if called on a rest.

Returns:

this Note's accidental value of SHARP, FLAT, or NATURAL.

getDuration

public double getDuration()

Returns this Note's duration in seconds.

Returns:

this Note's duration in seconds.

getOctave

public int getOctave()

Returns this Note's octave. The octave value is meaningless for a rest; this method will return OCTAVE_MIN + 1 by default if called on a rest.

Returns:

this Note's octave from OCTAVE_MIN to OCTAVE_MAX.

getPitch

public Pitch getPitch()

Returns this Note's pitch value of A-G or R for a rest.

Returns:

this Note's pitch value of A-G or R for a rest.

isRepeat

public boolean isRepeat()

Returns true if this Note is the start or end of a repeated section.

Returns:

true if this Note is the start or end of a repeated section, otherwise false.

isRest

public boolean isRest()

Returns true if this Note is a rest. Equivalent to checking whether this note's pitch is Pitch.R. Provided for convenience.

Returns:

true if this Note is a rest, otherwise false.

play

public void play()

Plays this note through the underlying audio system. Also prints a message to the system console for debugging. If the audio system is muted or paused, the note may not play.

setAccidental

public void setAccidental(Accidental accidental)

Sets this Note's accidental value to be the given value: SHARP, FLAT, or NATURAL. The accidental value is meaningless for a rest, but the Note object still maintains an accidental value internally (initially Accidental.NATURAL) which is ignored.

Parameters:

accidental - Note's accidental from Accidental.SHARP, FLAT, or NATURAL.

Throws:

NullPointerException - if the accidental is null.

setAccidental

public void setAccidental(String accidental)

Sets this Note's accidental value to be the given value: "SHARP", "FLAT", or "NATURAL". The accidental value is meaningless for a rest, but the Note object still maintains an accidental value internally (initially Accidental.NATURAL) which is ignored.

Parameters:

accidental - Note's accidental from "SHARP", "FLAT", or "NATURAL".

setDuration

public void setDuration(double duration)

Sets this Note's duration in seconds to be the given value.

Parameters:

duration - Note's duration in seconds.

Throws:

IllegalArgumentException - if duration is negative.

setOctave

public void setOctave(int octave)

Sets this Note's octave to be the given value. The octave value is meaningless for a rest, but the Note object still maintains an octave value internally (initially OCTAVE_MIN + 1) which is ignored.

Parameters:

octave - Note's octave from OCTAVE_MIN through OCTAVE_MAX inclusive.

Throws:

IllegalArgumentException - if octave is not between OCTAVE_MIN and OCTAVE_MAX inclusive.

setPitch

public void setPitch(Pitch pitch)

Sets this Note's pitch to be the given value.

Parameters:

pitch - Note's pitch from Pitch.A through Pitch.G, or Pitch.R for a rest.

Throws:

NullPointerException - if pitch is null.

setPitch

public void setPitch(String pitch)

Sets this Note's pitch to be the given value.

Parameters:

pitch - Note's pitch from "A" through "G", or "R" for a rest.

Throws:

NullPointerException - if pitch is null.

setRepeat

public void setRepeat(boolean repeat)

Sets this Note's repeat flag to be the given value.

Parameters:

repeat - true to indicate that this note is the start/end of a repeated section, or false if not.

toString

public String toString()

Returns a string representation of this note.

Overrides:

toString in class Object

Returns:

A string such as "0.4 C 5 NATURAL false".