package org.marketcetera.module;

import org.marketcetera.util.misc.ClassVersion;

import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlRootElement;
import javax.xml.bind.annotation.XmlValue;

import java.io.Serializable;
import java.beans.ConstructorProperties;

/* $License$ */
/**
 * Instances of this class uniquely identify a data flow.
 *
 * @author anshul@marketcetera.com
 * @version $Id: DataFlowID.java 16879 2014-04-15 21:40:25Z colin $
 * @since 1.0.0
 */
@XmlRootElement(name="dataFlowId")
@XmlAccessorType(XmlAccessType.FIELD)
@ClassVersion("$Id: DataFlowID.java 16879 2014-04-15 21:40:25Z colin $")
public final class DataFlowID implements Serializable {
    /**
     * Creates an instance.
     *
     * @param inValue the string value of the ID, the value cannot be null.
     */
    @ConstructorProperties({"value"})  //$NON-NLS-1$
    public DataFlowID(String inValue) {
        if(inValue == null) {
            throw new NullPointerException();
        }
        mValue = inValue;
    }

    /**
     * Constructor for use by JAXB during serialization. It's not meant
     * to be used for any other purpose.
     */
    @SuppressWarnings("unused")
    private DataFlowID() {
        this("");
    }

    /**
     * The string value of the ID.
     *
     * @return the string value of the ID.
     */
    public String getValue() {
        return mValue;
    }

    @Override
    public String toString() {
        return getValue();
    }

    @Override
    public int hashCode() {
        return mValue.hashCode();
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (o == null || getClass() != o.getClass()) return false;

        DataFlowID that = (DataFlowID) o;

        return mValue == null
                ? that.mValue == null
                : mValue.equals(that.mValue); 

    }
    @XmlValue
    private String mValue;
    private static final long serialVersionUID = -117964306857928984L;
}