com.ionos.network.commons.address.IPv4 Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of commons-network Show documentation

IP network related classes

There is a newer version: 0.14.0

package com.ionos.network.commons.address;

import java.io.Serializable;

/**
 * IP for the IPv4 protocol.
 * Stores the address bytes and has methods to calculate with IPs.
 * 

 * Objects of the IPv4 class are immutable!
 *
 * @see java.net.Inet4Address
 * @see IPVersion
 * @see IPFormats
 * @see IPParsers
 * @author Stephan Fuhrmann
 *
 **/
public final class IPv4 extends IP implements Address, Serializable {
    /** The version number of this class. */
    private static final long serialVersionUID = 1212884661391791729L;

    /** The IPv4 address {@code 0.0.0.0}. */
    public static final IPv4 IPV4_ALL_ZERO =
            new IPv4(BitsAndBytes.newArrayOf(
                    IPVersion.IPV4.getAddressBytes(),
                    (byte) 0));

    /** The IPv4 address {@code 255.255.255.255}. */
    public static final IPv4 IPV4_ALL_ONE =
            new IPv4(BitsAndBytes.newArrayOf(
                    IPVersion.IPV4.getAddressBytes(),
                    (byte) 255));

    /**
     * Creates a new IP address from the address bytes.
     *
     * @param inAddress a 4 byte address in network byte order.
     */
    protected IPv4(final byte[] inAddress) {
        super(inAddress, IPVersion.IPV4.getAddressBytes());
    }

    /**
     * Creates a new IP address from the address bytes.
     *
     * @param inAddress a String containing the IP address in a
     *                  notation supported by {@linkplain IPParsers}.
     * @see IPParsers#DOTTED_DECIMAL
     */
    public IPv4(final String inAddress) {
        this(IPParsers.DOTTED_DECIMAL.parseAsBytes(inAddress));
    }

    /**
     * Gets the IP version used in this IP address.
     * @return the IP version of this address.
     */
    public IPVersion getIPVersion() {
            return IPVersion.IPV4;
    }

    @Override
    protected IPv4 newInstance(final byte[] address) {
        return new IPv4(address);
    }

    @Override
    protected AddressFormat defaultAddressFormat() {
        return IPFormats.DOTTED_DECIMAL;
    }
}