nl.pvanassen.steam.store.common.Item Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of steam-api Show documentation

A Java API to access the Steam community market through the HTTP interface. This may be against the TOS so be careful using it!

There is a newer version: 3.0.8

Show newest version

package nl.pvanassen.steam.store.common;

/**
 * Base class for any item related stuff
 *
 * @author Paul van Assen
 */
public class Item {
    private final int appId;
    private final String urlName;
    private final String key;
    /**
     * Constructor
     *
     * @param appId App id of the item
     * @param urlName Url name of the item
     */
    public Item(int appId, String urlName) {
        this.appId = appId;
        this.urlName = urlName;
        key = appId + "-" + urlName;
    }

    /**
     * Copy constructor
     *
     * @param item Item to copy
     */
    protected Item(Item item) {
        this(item.appId, item.urlName);
    }

    /**
     * {@inheritDoc}
     *
     * @see java.lang.Object#equals(java.lang.Object)
     */
    @Override
    public boolean equals(Object obj) {
        if (this == obj) {
            return true;
        }
        if (obj == null) {
            return false;
        }
        if (!(obj instanceof Item)) {
            return false;
        }
        Item other = (Item) obj;
        if (appId != other.appId) {
            return false;
        }
        if (urlName == null) {
            if (other.urlName != null) {
                return false;
            }
        }
        else if (!urlName.equals(other.urlName)) {
            return false;
        }
        return true;
    }

    /**
     * @return Steam application id
     */
    public int getAppId() {
        return appId;
    }

    /**
     * @return A url for debugging
     */
    public String getUrl() {
        return "http://steamcommunity.com/market/listings/" + appId + "/" + urlName;
    }

    /**
     * @return Steam URL name
     */
    public String getUrlName() {
        return urlName;
    }

    /**
     * {@inheritDoc}
     *
     * @see java.lang.Object#hashCode()
     */
    @Override
    public int hashCode() {
        final int prime = 31;
        int result = 1;
        result = (prime * result) + appId;
        result = (prime * result) + ((urlName == null) ? 0 : urlName.hashCode());
        return result;
    }

    @Override
    public String toString() {
        return "Item [appId=" + appId + ", urlName=" + urlName + "]";
    }
    
    public Item getItem() {
        return new Item(appId, urlName);
    }
    
    public String getKey() {
        return key; 
    }
}