fr.faylixe.googlecodejam.client.webservice.ProblemInput Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of googlecodejam-client Show documentation
Java client API for Google Code Jam contest
There is a newer version: 1.4.11
package fr.faylixe.googlecodejam.client.webservice;

import fr.faylixe.googlecodejam.client.common.NamedObject;

import java.io.Serializable;

import org.apache.commons.lang3.builder.EqualsBuilder;
import org.apache.commons.lang3.builder.HashCodeBuilder;

import com.google.gson.annotations.SerializedName;

/**
 * POJO that aims to be bind to the /ContestInfo
 * request, using Gson API. {@link ProblemInput} instance belong
 * to a {@link Problem} object, and describes input submission
 * available for a given {@link Problem}.
 * 
 * @author fv
 */
public final class ProblemInput extends NamedObject implements Serializable {

	/** Serialization index. **/
	private static final long serialVersionUID = 1L;

	/** Constant used for small input. **/
	public static final String SMALL = "small";

	/** Constant used for large input. **/
	public static final String LARGE = "large";

	/** Difficulty rank of this problem input. **/
	@SerializedName("difficulty")
	private int difficulty;

	/** TODO : Figure out what number is for (PROBABLY NUMBER OF ATTEMPT). **/
	@SerializedName("number")
	private int number;

	/** Number of points this problem input deliver. **/
	@SerializedName("points")
	private int points;

	/** Parent problem of this input. **/
	private transient Problem parent;

	/**
	 * Suffix used for this problem input.
	 * Correspond to the attempt number in
	 * effective contest.
	 */
	@SerializedName("suffix")
	private String suffix;

	/**
	 * Getter for the parent problem of this input.
	 * 
	 * @return Parent problem instance of this input.
	 */
	public Problem getProblem() {
		return parent;
	}

	/**
	 * Sets the parent problem of this input.
	 * 
	 * @param parent Parent problem to set.
	 */
	protected void setParent(final Problem parent) {
		this.parent = parent;
	}

	/**
	 * Getter for the problem input difficulty.
	 * 
	 * @return Difficulty rank of this problem input. 
	 * @see #difficulty
	 */
	public int getDifficulty() {
		return difficulty;
	}

	/**
	 * Getter for the problem input number.
	 * 
	 * @return TODO : Figure out what number is for.
	 * @see #number
	 */
	public int getNumber() {
		return number;
	}

	/**
	 * Getter for the input number of point.
	 * 
	 * @return Number of points this problem input deliver.
	 * @see #points
	 */
	public int getPoints() {
		return points;
	}

	/**
	 * Getter for the input suffix.
	 * 
	 * @return Suffix used for this problem input.
	 * @see #suffix
	 */
	public String getSuffix() {
		return suffix;
	}
	
	/** {@inheritDoc} **/
	@Override
	public int hashCode() {
		final HashCodeBuilder builder = new HashCodeBuilder();
		builder
			.append(difficulty)
			.append(number)
			.append(points)
			.append(parent)
			.append(suffix);
		return builder.toHashCode();
	}
	
	/** {@inheritDoc} **/
	@Override
	public boolean equals(final Object object) {
		if (object == this) {
			return true;
		}
		if (object == null || object.getClass() != getClass()) {
			return false;
		}
		final ProblemInput other = (ProblemInput) object;
		final EqualsBuilder builder = new EqualsBuilder();
		builder
			.append(difficulty, other.getDifficulty())
			.append(number, other.getNumber())
			.append(points, other.getPoints())
			.append(parent, other.getProblem())
			.append(suffix, other.getSuffix());
		return builder.isEquals();
	}

}