Resource.java

package dwarf;

import java.util.Objects;
import java.io.InputStream;

/**
 * Helper class which represents a resource (res) within the project folders or
 * jar file.
 *
 * @author Matthew 'siD' Van der Bijl
 *
 * @see java.lang.Object
 * @see java.lang.Cloneable
 */
public class Resource extends java.lang.Object implements Cloneable {

    private String path;

    /**
     * Default constructor.
     */
    public Resource() {
        super();
    }

    /**
     * Constructs a new resource representation from the file in the given path.
     *
     * @param path the path of the resource file.
     */
    public Resource(String path) {
        super();
        this.path = path;
    }

    /**
     * Constructs a new resource representation from the <code>Resource</code>
     * given.
     *
     * @param r the given <code>Resource</code>.
     */
    public Resource(Resource r) {
        this(r.getPath());
    }

    /**
     * Returns the input stream from the resource data.
     *
     * @return the input stream from the resource data
     */
    public InputStream getInputStream() {
        Class<?> runtimeClass = getClass();
        ClassLoader classLoader = runtimeClass.getClassLoader();
        InputStream stream = classLoader.getResourceAsStream(getPath());

        return stream;
    }

    public String getPath() {
        return this.path;
    }

    public void setPath(String path) {
        this.path = path;
    }

    @Override
    public Object clone() throws CloneNotSupportedException {
        return new Resource(this);
    }

    @Override
    public int hashCode() {
        int hash = 7;
        hash = 83 * hash + Objects.hashCode(getPath());
        return hash;
    }

    /**
     * Returns true if the <code>this</code> is equal to the argument and false
     * otherwise. Consequently, if both argument are null, true is returned,
     * false is returned. Otherwise, equality is determined by using the equals
     * method of the first argument.
     *
     * @param obj the <code>Object</code> to be tested
     * @see java.lang.Object#equals(java.lang.Object)
     *
     * @return true if the argument is equal to <code>this</code> other and
     * false otherwise
     */
    @Override
    public boolean equals(Object obj) {
        if (obj == null) {
            return false;
        } else if (getClass() != obj.getClass()) {
            return false;
        }

        final Resource other = (Resource) obj;

        if (!Objects.equals(this.getPath(), other.getPath())) {
            return false;
        }

        return true;
    }

    /**
     * Returns a string representation of the object.
     * <p>
     * In general, the toString method returns a string that "textually
     * represents" this object. The result should be a concise but informative
     * representation that is easy for a person to read. It is recommended that
     * all subclasses override this method.</p>
     *
     * @return a textually representation of this object
     */
    @Override
    public String toString() {
        return "Resource[" + "path: " + getPath() + "]";
    }

    public Resource get() {
        return this;
    }

    public void set(String path) {
        this.path = path;
    }

    public void set(Resource r) {
        this.path = r.getPath();
    }
}