src/main/java/net/onrc/onos/core/util/SwitchPort.java

package net.onrc.onos.core.util;

import net.onrc.onos.core.util.serializers.SwitchPortSerializer;

import org.apache.commons.lang.Validate;
import org.codehaus.jackson.map.annotate.JsonSerialize;

/**
 * The class representing a Switch-Port.
 * This class is immutable.
 */
@JsonSerialize(using = SwitchPortSerializer.class)
public final class SwitchPort {
    private final Dpid dpid;        // The DPID of the switch
    private final PortNumber port;        // The port of the switch

    /**
     * Default constructor for Serializer to use.
     */
    protected SwitchPort() {
        this.dpid = null;
        this.port = null;
    }

    /**
     * Constructor for a given DPID and a port.
     *
     * @param dpid the DPID to use.
     * @param port the port to use.
     */
    public SwitchPort(Dpid dpid, PortNumber port) {
        Validate.notNull(dpid);
        Validate.notNull(port);
        this.dpid = dpid;
        this.port = port;
    }

    /**
     * Constructor for the specified primitive values of a DPID and port.
     *
     * @param dpid the long DPID to use
     * @param port the short port number to use
     */
    public SwitchPort(long dpid, short port) {
        this.dpid = new Dpid(dpid);
        this.port = new PortNumber(port);
    }

    /**
     * Constructor for the specified primitive values of a DPID and port.
     *
     * @param dpid the DPID to use
     * @param port the port number to use
     */
    public SwitchPort(Long dpid, Long port) {
        this.dpid = new Dpid(dpid);
        this.port = new PortNumber(port.shortValue());
    }

    /**
     * Get the DPID value of the Switch-Port.
     *
     * @return the DPID value of the Switch-Port.
     */
    public Dpid dpid() {
        return dpid;
    }

    /**
     * Get the DPID value of the Switch-Port.
     *
     * @return the DPID value of the Switch-Port.
     */
    public Dpid getDpid() {
        return dpid;
    }

    /**
     * Get the port value of the Switch-Port.
     *
     * @return the port value of the Switch-Port.
     */
    public PortNumber port() {
        return port;
    }

    /**
     * Get the port number of the Switch-Port.
     *
     * @return the port number of the Switch-Port.
     */
    public PortNumber getPortNumber() {
        return port;
    }

    /**
     * Convert the Switch-Port value to a string.
     * <p/>
     * The string has the following form:
     * 01:02:03:04:05:06:07:08/1234
     *
     * @return the Switch-Port value as a string.
     */
    @Override
    public String toString() {
        return this.dpid.toString() + "/" + this.port;
    }

    @Override
    public boolean equals(Object other) {
        if (!(other instanceof SwitchPort)) {
            return false;
        }

        SwitchPort otherSwitchPort = (SwitchPort) other;

        return (dpid.equals(otherSwitchPort.dpid) &&
                port.equals(otherSwitchPort.port));
    }

    @Override
    public int hashCode() {
        int hash = 17;
        hash += 31 * hash + dpid.hashCode();
        hash += 31 * hash + port.hashCode();
        return hash;
    }
}