utils/misc/src/main/java/org/onlab/packet/VLANID.java

package org.onlab.packet;

/**
 * Representation of a VLAN ID.
 */
// FIXME: This will end-up looking like a constant; we should name it 'VlanId', 'IpAddress', 'MacAddress'.
public class VLANID {

    private final short value;
    // Based on convention used elsewhere? Check and change if needed
    public static final short UNTAGGED = (short) 0xffff;
    // A VLAN ID is actually 12 bits of a VLAN tag.
    public static final short MAX_VLAN = 4095;

    protected VLANID() {
        this.value = UNTAGGED;
    }

    protected VLANID(short value) {
        this.value = value;
    }

    public static VLANID vlanId() {
        return new VLANID(UNTAGGED);
    }

    public static VLANID vlanId(short value) {
        if (value == UNTAGGED) {
            return new VLANID();
        }

        if (value > MAX_VLAN) {
            throw new IllegalArgumentException(
                    "value exceeds allowed maximum VLAN ID value (4095)");
        }
        return new VLANID(value);
    }

    public short toShort() {
        return this.value;
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj) {
            return true;
        }

        if (obj instanceof VLANID) {

            VLANID other = (VLANID) obj;

             if (this.value == other.value) {
                return true;
            }
        }

        return false;
    }

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

    @Override
    public String toString() {
        return String.valueOf(this.value);
    }
}