employee.java

icarnegie SSD3 CatalogGUI

/**
 * This class models an employee. The following information is maintained:
 * <ol>
 * <li>the ID of the employee, an <code>int</code></li>
 * <li>the name of the employee, a <code>String</code></li>
 * <li>the salary of the employee, a <code>double</code></li>
 * </ol>
 *
 * @author  iCarnegie
 * @version  1.0.0
 */
public class  Employee {

	/* The ID of the employee */
	private int id;

	/* The name of the employee */
	private String  name;

	/* The salary of the employee */
	private double  salary;

	/**
	 * Creates an employee object with the specified ID, name, and salary.
	 *
	 * @param initialId  the ID of the employee.
	 * @param initialName  the name of the employee.
	 * @param initialSalary  the salary of the employee.
	 */
	public Employee(int initialId, String initialName, double initialSalary) {

		this.id = initialId;
		this.name = initialName;
		this.salary = initialSalary;
	}

	/**
	 * Returns the ID of this employee.
	 *
	 * @return  the ID of this employee.
	 */
	public int  getId()  {

		return  this.id;
	}

	/**
	 * Returns the name of this employee.
	 *
	 * @return  the name of this employee.
	 */
	public String  getName()  {

		return  this.name;
	}

	/**
	 * Returns the salary of this employee.
	 *
	 * @return  the salary of this employee.
	 */
	public double  getSalary()  {

		return  this.salary;
	}

	/**
	 * Modifies the salary of this employee.
	 *
	 * @param newSalary  the new salary of this employee.
	 */
	public void  setSalary(double newSalary)  {

		this.salary = newSalary;
	}


	/**
	 * Overrides {@link Object#equals(Object)}: Two <code>Employee</code>
	 * objects are equal if their ID, name, and salary are the same.
	 * </p>
	 *
	 * @param object  object which this <code>Employee</code> is compared.
	 * @return  <code>true</code> if the ID, name, and salary of
	 *          this <code>Employee</code> are equal to the ID, name, and
	 *          salary of the parameter; <code>false</code> otherwise.
	 */
	public boolean  equals(Object  object)  {

		if (object instanceof Employee) {

			Employee employee = (Employee) object;

			return employee.getId() == getId()
				&& employee.getName().equals(getName())
				&& employee.getSalary() == getSalary();

		} else {

			return false;
		}
	}

	/**
	 * Returns the string representation of this employee in the
	 * following format:  <i>ID</i>_<i>name</i>_<i>salary</i>
	 *
	 * @return a string representation of this employee.
	 */
	public String  toString()  {

		return getId() + "_" + getName() + "_" + getSalary();
	}
}