Graphic.java

package com.asteria.game.character;

/**
 * The container class that represents an graphic.
 *
 * @author lare96 <http://github.com/lare96>
 */
public final class Graphic {

    /**
     * The identification for this graphic.
     */
    private final int id;

    /**
     * The height of this graphic.
     */
    private final int height;

    /**
     * Creates a new {@link Graphic}.
     *
     * @param id
     *            the identification for this graphic.
     * @param height
     *            the height of this graphic.
     */
    public Graphic(int id, int height) {
        this.id = id;
        this.height = height;
    }

    /**
     * Creates a new {@link Graphic} with a {@code height} of {@code 0}.
     *
     * @param id
     *            the identification for this graphic.
     */
    public Graphic(int id) {
        this(id, 0);
    }

    /**
     * A substitute for {@link Object#clone()} that creates another 'copy' of
     * this instance. The created copy is <i>safe</i> meaning it does not hold
     * <b>any</b> references to the original instance.
     *
     * @return a reference-free copy of this instance.
     */
    public Graphic copy() {
        return new Graphic(id, height);
    }

    /**
     * Gets the identification for this graphic.
     *
     * @return the identification for this graphic.
     */
    public int getId() {
        return id;
    }

    /**
     * Gets the height of this graphic.
     *
     * @return the height of this graphic.
     */
    public int getHeight() {
        return height;
    }
}