Class Musician

java.lang.Object

Musician

public class Musician
extends java.lang.Object

This class allows one to create objects that represent Musicians.

Constructor Summary

Constructors

Constructor and Description
Musician(Musician otherMusician) This copy constructor creates a new Musician object copying the relevant details from another Musician object.
Musician(java.lang.String name, java.lang.String instrument, java.lang.String office, SymphonySection section, boolean principle) This function constructs a new Musician object using the provided parameters.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Musician other) The function equals properly compares Musician objects.
java.lang.String	getInstrument() This function returns the musician's instrument.
java.lang.String	getName() This function returns the musician's name.
static int	getNumberInSection(SymphonySection section) This function returns the number of musicians in the specified section of the symphony.
static int	getNumberOfMusicians() This function returns the total number of musicians.
java.lang.String	getOffice() This function returns the musician's office number.
SymphonySection	getSection() This function returns the musician's Orchestra Section.
boolean	isPrinciple() This function indicates whether the musician is the Principle of their section.
static void	main(java.lang.String[] args) Some code to test our class.
void	setInstrument(java.lang.String instrument) This function sets a musician's Instrument.
void	setName(java.lang.String name) This function sets a musician's Name.
void	setOffice(java.lang.String office) This function sets a musician's Office number.
void	setPrinciple(boolean principle) This function sets whether a musician is the Principle of their section.
void	setSection(SymphonySection section) This function sets a musician's Orchestra Section, updating the symphony section counts as necessary.
java.lang.String	toString() The function toString outputs detailed information for the Musician class.

Methods inherited from class java.lang.Object

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

Constructor Detail

Musician

public Musician(java.lang.String name,
        java.lang.String instrument,
        java.lang.String office,
        SymphonySection section,
        boolean principle)

This function constructs a new Musician object using the provided parameters.

Parameters:

name - Is the name to assign to the new Musician.

instrument - Is the instrument to assign to the new Musician.

office - Is the office number to assign to the new Musician.

section - Is the SymphonySection to assign to the new Musician.

principle - Is a boolean indicating whether the new Musician is the Principle of his or her section.

Musician

public Musician(Musician otherMusician)

This copy constructor creates a new Musician object copying the relevant details from another Musician object.

Parameters:

otherMusician - Another Musician object to make a copy of.

Method Detail

toString

public java.lang.String toString()

The function toString outputs detailed information for the Musician class. The text is generated according to this pattern:
"Musician:name,instrument,office,section,Principle=boolean"
So, for example, this musician:
Musician m = new Musician("Niccolo Paganini", "Violin", "Room B-7", SymphonySection.Strings, true);
would produce the following toString text:
"Musician:Niccolo Paganini,Violin,Room B-7,Strings,Principle=true"

Overrides:

toString in class java.lang.Object

Returns:

The string returned looks like this: "Musician:name,instrument,office,section,Principle=boolean"

equals

public boolean equals(Musician other)

The function equals properly compares Musician objects.

Returns:

A boolean indicating whether the objects are identical.

getName

public java.lang.String getName()

This function returns the musician's name.

Returns:

A String containing the musician's name.

getInstrument

public java.lang.String getInstrument()

This function returns the musician's instrument.

Returns:

A String containing the musician's instrument.

getOffice

public java.lang.String getOffice()

This function returns the musician's office number.

Returns:

A String containing the musician's office number.

getSection

public SymphonySection getSection()

This function returns the musician's Orchestra Section.

Returns:

A SymphonySection containing the musician's Section.

isPrinciple

public boolean isPrinciple()

This function indicates whether the musician is the Principle of their section.

Returns:

A boolean indicating whether the musician is the Principle of their section.

setName

public void setName(java.lang.String name)

This function sets a musician's Name.

Parameters:

name - is a String representing the musician's name.

setInstrument

public void setInstrument(java.lang.String instrument)

This function sets a musician's Instrument.

Parameters:

instrument - is a String representing the musician's instrument.

setOffice

public void setOffice(java.lang.String office)

This function sets a musician's Office number.

Parameters:

office - is a String representing the musician's Office number.

setSection

public void setSection(SymphonySection section)

This function sets a musician's Orchestra Section, updating the symphony section counts as necessary.

Parameters:

section - is a SymphonySection indicating the musician's Orchestra Section.

setPrinciple

public void setPrinciple(boolean principle)

This function sets whether a musician is the Principle of their section.

Parameters:

principle - is a boolean that indicates whether the musician is the Principle of their section.

main

public static void main(java.lang.String[] args)

Some code to test our class.

getNumberOfMusicians

public static int getNumberOfMusicians()

This function returns the total number of musicians. The total includes all of the musicians in all symphony sections.

Returns:

The total number of musicians.

getNumberInSection

public static int getNumberInSection(SymphonySection section)

This function returns the number of musicians in the specified section of the symphony.

Returns:

The number of musicians in the corresponding section, or zero if an invalid section is provided.