Joke - Android Lab 2

package edu.calpoly.android.lab2;

/**
 * This class encapsulates the data pertaining to a Joke.
 */
public class Joke {

	/** The three possible rating values for jokes. */
	public static final int UNRATED = 0;
	public static final int LIKE = 1;
	public static final int DISLIKE = 2;
	
	/** Contains the text of this joke. */
	private String m_strJoke;
	
	/** Contains the rating of this joke, should only be one of the constant
	 * rating values declared above. */
	private int m_nRating;
	
	/**
	 * Initializes a joke with an empty string and the default rating of 
	 * UNRATED.
	 */
	public Joke() {
		//TODO
        this.m_strJoke = "";
        this.m_nRating = Joke.UNRATED;
	}
	
	/**
	 * Initializes a joke with the string passed in and the default rating of 
	 * UNRATED.
	 * 
	 * @param strJoke		Joke String used to initialize the text of this 
	 * 						joke.
	 */
	public Joke(String strJoke) {
		//TODO
        this.m_strJoke = strJoke;
        this.m_nRating = Joke.UNRATED;
	}
	
	/**
	 * Initializes a joke with the string and rating values passed in.
	 * 
	 * @param strJoke	Joke String used to initialize the text of this 
	 * 					joke.
	 * 
	 * @param dLike	Rating value to initialize the rating of this joke.
	 */
	public Joke(String strJoke, int nRating) {
		//TODO
        this.m_strJoke = strJoke;
        this.m_nRating = nRating;
	}
	
	/**
	 * Accessor for the text of this joke.
	 * 
	 * @return	A String value containing the text of this joke.
	 */
	public String getJoke() {
		//TODO
		return new String(this.m_strJoke);
	}

	/**
	 * Mutator that changes the text of this joke.
	 *  
	 * @param strJoke	The text of this joke.
	 */
	public void setJoke(String mstrJoke) {
		//TODO
        this.m_strJoke = mstrJoke;
	}

	/**
	 * Accessor for the rating of this joke.
	 * 
	 * @return	An integer value containing one of the possible 
	 * 			rating constants.
	 */
	public int getRating() {
		//TODO
		return this.m_nRating;
	}
	
	/**
	 * Mutator that changes the rating of this joke.
	 *  
	 * @param rating	One of the possible rating constants.
	 */
	public void setRating(int rating) {
		//TODO
        this.m_nRating = rating;
	}
	
	/**
	 * Returns only the text of the joke. This method should mimic getJoke().
	 * 
	 * @return	A string containing the text of the joke
	 */
	@Override
	public String toString() {
		//TODO
		return new String(this.m_strJoke);
	}
	
	/**
	 * An Object is equal to this Joke, if the Object is a Joke and its text is
	 * the same as this Joke's text. Text equality is defined by 
	 * String.equals(...). The rating is ignored in the determination of 
	 * equality.
	 * 
	 * @return	True if the object passed in is a Joke with the same text as
	 * 			this one; False otherwise.
	 */
	@Override
	public boolean equals(Object obj) {
		//TODO
		if(obj instanceof Joke){
			String joke1 = this.getJoke();
			String joke2 = ((Joke)obj).getJoke();
			return joke1.equals(joke2);
		}
		return false;
	}
}