Class NewsMaker

java.lang.Object

NewsMaker

class NewsMaker
extends java.lang.Object

Project #1 CS 2334, Section 010 February 22, 2017

A NewsMaker is the subject of a NewspaperStory. A NewsMaker may be a person or an organization. A NewsMaker consists of a name and a collection of newspaper stories that feature that NewsMaker. There is a special NewsMaker with the name "None" that is used for newspaper stories that don't have at least two named NewsMakers.

Version:

1.0

Author:

Dean Hougen

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	name The name of the news maker.
private NewspaperStoryList	newspaperStories The list of newspaper stories in which the news maker is featured

Constructor Summary

Constructors

Constructor and Description
NewsMaker() The no-argument constructor for the class.
NewsMaker(java.lang.String name) The general constructor for the class which takes the name of the news maker (generally the only thing we know about a news maker when the constructor is called) as an argument.

Method Summary

Modifier and Type	Method and Description
void	addNewspaperStory(NewspaperStory newspaperStory) The mutator that adds a newspaper story to a news maker's list of stories.
boolean	equals(java.lang.Object o) An overridden equals method.
java.lang.String	getName() The accessor for the name field.
NewspaperStoryList	getNewspaperStories() The accessor for the list of newspaper stories.

Methods inherited from class java.lang.Object

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

Field Detail

name

private java.lang.String name

The name of the news maker.

newspaperStories

private NewspaperStoryList newspaperStories

The list of newspaper stories in which the news maker is featured

Constructor Detail

NewsMaker

NewsMaker()

The no-argument constructor for the class. Because we will often want to construct the special news maker "None," the no-arg constructor gives us this news maker.

NewsMaker

public NewsMaker(java.lang.String name)

The general constructor for the class which takes the name of the news maker (generally the only thing we know about a news maker when the constructor is called) as an argument.

Parameters:

name - The name of the news maker.

Method Detail

equals

public boolean equals(java.lang.Object o)

An overridden equals method.

A NewsMaker should be equal to another object if that object is also a NewsMaker object and they have the same name. (Since equals is a method in the Object class that we are overriding, the parameter needs to be an Object.)

Overrides:

equals in class java.lang.Object

Parameters:

o - The Object to which to compare this.

getName

public java.lang.String getName()

The accessor for the name field.

Note that String objects are immutable, so it is fine to return the field itself.

Returns:

The name of the news maker.

getNewspaperStories

public NewspaperStoryList getNewspaperStories()

The accessor for the list of newspaper stories.

Note that NewsPaperstoryList objects are mutable, so this really should return a copy of the list instead. However, we haven't studied that yet, so returning the list itself is acceptable for now.

Returns:

The list of stories featuring the news maker.

addNewspaperStory

public void addNewspaperStory(NewspaperStory newspaperStory)

The mutator that adds a newspaper story to a news maker's list of stories.

Note that since this list should contain only stories in which the news maker is featured, we should have this method verify that the NewsMaker object is referenced in the NewspaperStory object before the story is added to the list. However, to keep the project relatively simple, this requirement was not made in the project description and this check doesn't need to be made yet.

Parameters:

newspaperStory - The newspaper story to add.