com.github.sdnwiselab.sdnwise.util.NodeAddress Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sdn-wise-api Show documentation
The stateful Software Defined Networking solution for WIreless SEnsor Networks.
There is a newer version: 3.0.10
/* 
 * Copyright (C) 2015 SDN-WISE
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see .
 */
package com.github.sdnwiselab.sdnwise.util;

import static com.github.sdnwiselab.sdnwise.packet.NetworkPacket.BROADCAST_ADDR;
import java.io.Serializable;

/**
 * This Class is used to represent NodeAddress Object. It implements Comparable
 * to compare more NodeAddress and Serializable to serialize this object.
 *
 * @author Sebastiano Milardo
 * @version %I%, %G%
 */
public final class NodeAddress implements Comparable, Serializable {

    private static final long serialVersionUID = 1L;
    private final byte[] addr = new byte[2];

    /**
     * Constructor method to create a Node Address by an int.
     *
     * @param addr int value to set a Node Address.
     */
    public NodeAddress(int addr) {
        this.addr[0] = (byte) (addr >> 8);
        this.addr[1] = (byte) (addr & 0xFF);
    }

    /**
     *
     * Constructor method to create a Node Address by a byte array.
     *
     * @param addr byte array value to set a Node Address.
     */
    public NodeAddress(byte[] addr) {
        if (addr.length == 2) {
            this.addr[0] = addr[0];
            this.addr[1] = addr[1];
        }
    }

    /**
     * Constructor method to create a Node Address by a string.
     *
     * @param addr string value to set a Node Address.
     */
    public NodeAddress(String addr) {
        String[] add = addr.split("\\s*\\.\\s*");
        if (add.length == 2) {
            this.addr[0] = (byte) Integer.parseInt(add[0]);
            this.addr[1] = (byte) Integer.parseInt(add[1]);
        } else {
            int adr = Integer.parseInt(addr);
            this.addr[0] = (byte) (adr >> 8);
            this.addr[1] = (byte) (adr & 0xFF);
        }
    }

    /**
     * Constructor method to create a Node Address by two int.
     *
     * @param addr0 int value to set fist part of Node Address.
     * @param addr1 int value to set second part of a Node Address.
     */
    public NodeAddress(int addr0, int addr1) {
        this.addr[0] = (byte) addr0;
        this.addr[1] = (byte) addr1;
    }

    /**
     * Getter method to obtain int value from addr[].
     *
     * @return int value of addr[].
     */
    public int intValue() {
        return ((addr[0] & 0xFF) * 256) + (addr[1] & 0xFF);
    }

    /**
     * Get High Part of a NodeAddress.
     *
     * @return a byte value of High Part of a NodeAddress.
     */
    public byte getHigh() {
        return addr[0];
    }

    /**
     * Get Low Part of a NodeAddress.
     *
     * @return a byte value of Low Part of a NodeAddress.
     */
    public byte getLow() {
        return addr[1];
    }

    /**
     * Get Node Address in Byte.
     *
     * @return a byte array of Node Address.
     */
    public Byte[] getArray() {
        return new Byte[]{addr[0], addr[1]};
    }

    @Override
    public String toString() {
        return ((addr[0] & 0xFF) + "." + (addr[1] & 0xFF));
    }

    @Override
    public int compareTo(NodeAddress other) {
        return Integer.valueOf(this.intValue()).compareTo(other.intValue());
    }

    @Override
    public int hashCode() {
        return Integer.valueOf(this.intValue()).hashCode();
    }

    @Override
    public boolean equals(Object obj) {
        return obj instanceof NodeAddress && ((NodeAddress) obj).intValue() == this.intValue();
    }

    /**
     * Check if the address is a broadcast address
     *
     * @return true if equal to 255.255 false otherwise
     */
    public boolean isBroadcast() {
        return this.equals(BROADCAST_ADDR);
    }
}