ChronicleEntry.java

/**
 * ChronicleEntry.java
 * Copyright James Dempsey, 2011
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 *
 * Created on 30/09/2011 10:17:51 PM
 *
 * $Id$
 */
package pcgen.core;

import pcgen.facade.core.ChronicleEntryFacade;

/**
 * The Class {@code ChronicleEntry} contains a record of an
 * event in the character's history. 
 *
 * <br>
 * 
 * @author James Dempsey <jdempsey@users.sourceforge.net>
 */
public class ChronicleEntry implements ChronicleEntryFacade, Cloneable
{
	private boolean outputEntry = true;
	private String campaign = "";
	private String adventure = "";
	private String party = "";
	private String date = "";
	private int xpField = 0;
	private String gmField = "";
	private String chronicle = "";
	
	/**
	 * @return the outputEntry
	 */
    @Override
	public boolean isOutputEntry()
	{
		return outputEntry;
	}
	/**
	 * @param outputEntry the outputEntry to set
	 */
    @Override
	public void setOutputEntry(boolean outputEntry)
	{
		this.outputEntry = outputEntry;
	}
	/**
	 * @return the campaign
	 */
    @Override
	public String getCampaign()
	{
		return campaign;
	}
	/**
	 * @param campaign the campaign to set
	 */
    @Override
	public void setCampaign(String campaign)
	{
		this.campaign = campaign;
	}
	/**
	 * @return the adventure
	 */
    @Override
	public String getAdventure()
	{
		return adventure;
	}
	/**
	 * @param adventure the adventure to set
	 */
    @Override
	public void setAdventure(String adventure)
	{
		this.adventure = adventure;
	}
	/**
	 * @return the party
	 */
    @Override
	public String getParty()
	{
		return party;
	}
	/**
	 * @param party the party to set
	 */
    @Override
	public void setParty(String party)
	{
		this.party = party;
	}
	/**
	 * @return the date
	 */
    @Override
	public String getDate()
	{
		return date;
	}
	/**
	 * @param date the date to set
	 */
    @Override
	public void setDate(String date)
	{
		this.date = date;
	}
	/**
	 * @return the xpField
	 */
    @Override
	public int getXpField()
	{
		return xpField;
	}
	/**
	 * @param xpField the xpField to set
	 */
    @Override
	public void setXpField(int xpField)
	{
		this.xpField = xpField;
	}
	/**
	 * @return the gmField
	 */
    @Override
	public String getGmField()
	{
		return gmField;
	}
	/**
	 * @param gmField the gmField to set
	 */
    @Override
	public void setGmField(String gmField)
	{
		this.gmField = gmField;
	}
	/**
	 * @return the chronicle
	 */
    @Override
	public String getChronicle()
	{
		return chronicle;
	}
	/**
	 * @param chronicle the chronicle to set
	 */
    @Override
	public void setChronicle(String chronicle)
	{
		this.chronicle = chronicle;
	}
	
	@Override
	public ChronicleEntry clone() throws CloneNotSupportedException
	{
		return (ChronicleEntry) super.clone();
	}

	@Override
	public int hashCode()
	{
		final int prime = 31;
		int result = 1;
		result =
				prime * result
					+ ((adventure == null) ? 0 : adventure.hashCode());
		result =
				prime * result + ((campaign == null) ? 0 : campaign.hashCode());
		result =
				prime * result
					+ ((chronicle == null) ? 0 : chronicle.hashCode());
		result = prime * result + ((date == null) ? 0 : date.hashCode());
		result = prime * result + ((gmField == null) ? 0 : gmField.hashCode());
		result = prime * result + (outputEntry ? 1231 : 1237);
		result = prime * result + ((party == null) ? 0 : party.hashCode());
		result = prime * result + xpField;
		return result;
	}
	@Override
	public boolean equals(Object obj)
	{
		if (this == obj)
		{
			return true;
		}
		if (obj == null)
		{
			return false;
		}
		if (getClass() != obj.getClass())
		{
			return false;
		}
		ChronicleEntry other = (ChronicleEntry) obj;
		if (adventure == null)
		{
			if (other.adventure != null)
			{
				return false;
			}
		}
		else if (!adventure.equals(other.adventure))
		{
			return false;
		}
		if (campaign == null)
		{
			if (other.campaign != null)
			{
				return false;
			}
		}
		else if (!campaign.equals(other.campaign))
		{
			return false;
		}
		if (chronicle == null)
		{
			if (other.chronicle != null)
			{
				return false;
			}
		}
		else if (!chronicle.equals(other.chronicle))
		{
			return false;
		}
		if (date == null)
		{
			if (other.date != null)
			{
				return false;
			}
		}
		else if (!date.equals(other.date))
		{
			return false;
		}
		if (gmField == null)
		{
			if (other.gmField != null)
			{
				return false;
			}
		}
		else if (!gmField.equals(other.gmField))
		{
			return false;
		}
		if (outputEntry != other.outputEntry)
		{
			return false;
		}
		if (party == null)
		{
			if (other.party != null)
			{
				return false;
			}
		}
		else if (!party.equals(other.party))
		{
			return false;
		}
		if (xpField != other.xpField)
		{
			return false;
		}
		return true;
	}
}