IPAddress (ip-utils 1.3.2 API)

java.lang.Object
- com.github.robtimus.net.ip.IPAddress<IP>

Type Parameters:

IP - The IP address subclass.

All Implemented Interfaces:

Comparable<IP>

Direct Known Subclasses:

IPv4Address, IPv6Address
```
public abstract class IPAddress<IP extends IPAddress<IP>>
extends Object
implements Comparable<IP>
```
Represents an IP address. Immutable.
Unlike InetAddress, this class is more lightweight and contains only the IP address itself, not host names.

Author:

Rob Spoor

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract IPRange<IP>`	`asRange()` Returns an IP range containing only this IP address.
`abstract int`	`bits()` Returns the number of bits required to store the IP address.
`abstract boolean`	`equals(Object o)` Tests whether or not another object is equal to this IP address.
`abstract int`	`hashCode()` Returns a hash code value for this IP address.
`abstract boolean`	`hasNext()` Returns whether or not there is a next IP address.
`abstract boolean`	`hasPrevious()` Returns whether or not there is a previous IP address.
`static Predicate<CharSequence>`	`ifValidIPAddress(Predicate<? super IPAddress<?>> predicate)` Returns a predicate that checks whether or not `CharSequence`s are valid IP addresses that match a specific predicate.
`abstract Subnet<IP>`	`inSubnet(int prefixLength)` Returns a subnet of a specific prefix length that contains this IP address.
`static boolean`	`isIPAddress(CharSequence s)` Tests whether or not a `CharSequence` is a valid IP address.
`static boolean`	`isIPAddress(CharSequence s, int start, int end)` Tests whether or not a portion of a `CharSequence` is a valid IP address.
`abstract boolean`	`isLinkLocalAddress()` Returns whether or not this IP address is a link local address.
`abstract boolean`	`isLoopbackAddress()` Returns whether or not this IP address is a loopback address.
`abstract boolean`	`isMulticastAddress()` Returns whether or not this IP address is an IP multicast address.
`abstract boolean`	`isSiteLocalAddress()` Returns whether or not this IP address is a site local address.
`abstract boolean`	`isWildcardAddress()` Returns whether or not this IP address is a wildcard address.
`abstract IP`	`next()` Returns the next IP address if it exists.
`abstract IP`	`previous()` Returns the previous IP address if it exists.
`abstract IPRange<IP>`	`to(IP end)` Returns an IP range starting at this IP address and ending in another IP address.
`abstract byte[]`	`toByteArray()` Returns a byte array representation of this IP address.
`InetAddress`	`toInetAddress()` Returns this IP address as an `InetAddress`.
`String`	`toString()` Returns a string representation of this IP address.
`static Optional<IPAddress<?>>`	`tryValueOf(CharSequence address)` Attempts to return an IP address represented by a `CharSequence`.
`static Optional<IPAddress<?>>`	`tryValueOf(CharSequence address, int start, int end)` Attempts to return an IP address represented by a portion of a `CharSequence`.
`static IPAddress<?>`	`valueOf(byte[] address)` Returns an IP address from a byte array representation of the address.
`static IPAddress<?>`	`valueOf(CharSequence address)` Returns an IP address represented by a `CharSequence`.
`static IPAddress<?>`	`valueOf(CharSequence address, int start, int end)` Returns an IP address represented by a portion of a `CharSequence`.
`static IPAddress<?>`	`valueOf(InetAddress address)` Returns an IP address represented by a `InetAddress`.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Comparable
compareTo

- Method Detail
  - bits
```
public abstract int bits()
```
    Returns the number of bits required to store the IP address.
    
    Returns:
    
    The number of bits required to store the IP address.
  - toByteArray
```
public abstract byte[] toByteArray()
```
    Returns a byte array representation of this IP address. Its size is equal to bits() divided by Byte.SIZE. Furthermore, the result is in network byte order; the highest order byte is in the first element.
    
    Returns:
    
    A byte array representation of this IP address.
  - toInetAddress
```
public InetAddress toInetAddress()
```
    Returns this IP address as an InetAddress.
    
    Returns:
    
    This IP address as an InetAddress.
  - equals
```
public abstract boolean equals(Object o)
```
    Tests whether or not another object is equal to this IP address. An object is equal if it is a IP address with an equal return value of toByteArray().
    Implementations do not necessary need to use toByteArray(), as long as equal IP addresses also have equal byte array representations.
    
    Overrides:
    
    equals in class Object
  - hashCode
```
public abstract int hashCode()
```
    Returns a hash code value for this IP address.
    Implementations do not necessarily need to use toByteArray(), as long as the general contract as specified by Object.hashCode() is not violated.
    
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Returns a string representation of this IP address. When this string representation is used with IPAddressFormatter.parse(CharSequence), the resulting IP address should be equal to this IP address.
    
    Overrides:
    
    toString in class Object
  - isMulticastAddress
```
public abstract boolean isMulticastAddress()
```
    Returns whether or not this IP address is an IP multicast address.
    
    Returns:
    
    true if this IP address is an IP multicast address, or false otherwise.
    
    See Also:
    
    InetAddress.isMulticastAddress()
  - isWildcardAddress
```
public abstract boolean isWildcardAddress()
```
    Returns whether or not this IP address is a wildcard address.
    
    Returns:
    
    true if this IP address is a wildcard address, or false otherwise.
    
    See Also:
    
    InetAddress.isAnyLocalAddress()
  - isLoopbackAddress
```
public abstract boolean isLoopbackAddress()
```
    Returns whether or not this IP address is a loopback address.
    
    Returns:
    
    true if this IP address is a loopback address, or false otherwise.
    
    See Also:
    
    InetAddress.isLoopbackAddress()
  - isLinkLocalAddress
```
public abstract boolean isLinkLocalAddress()
```
    Returns whether or not this IP address is a link local address.
    
    Returns:
    
    true if this IP address is a link local address, or false otherwise.
    
    See Also:
    
    InetAddress.isLinkLocalAddress()
  - isSiteLocalAddress
```
public abstract boolean isSiteLocalAddress()
```
    Returns whether or not this IP address is a site local address.
    
    Returns:
    
    true if this IP address is a site local address, or false otherwise.
    
    See Also:
    
    InetAddress.isSiteLocalAddress()
  - hasNext
```
public abstract boolean hasNext()
```
    Returns whether or not there is a next IP address.
    
    Returns:
    
    true if there is a next IP address, or false otherwise.
  - next
```
public abstract IP next()
```
    Returns the next IP address if it exists.
    
    Returns:
    
    The next IP address.
    
    Throws:
    
    NoSuchElementException - If there is no next IP address.
    
    See Also:
    
    hasNext()
  - hasPrevious
```
public abstract boolean hasPrevious()
```
    Returns whether or not there is a previous IP address.
    
    Returns:
    
    true if there is a previous IP address, or false otherwise.
  - previous
```
public abstract IP previous()
```
    Returns the previous IP address if it exists.
    
    Returns:
    
    The previous IP address.
    
    Throws:
    
    NoSuchElementException - If there is no previous IP address.
    
    See Also:
    
    hasPrevious()
  - to
```
public abstract IPRange<IP> to(IP end)
```
    Returns an IP range starting at this IP address and ending in another IP address.
    
    Parameters:
    
    end - The end of the IP range, inclusive.
    
    Returns:
    
    An IP range from this IP address to the given IP address.
    
    Throws:
    
    NullPointerException - If the given IP address is null.
    
    IllegalArgumentException - If the given IP address is smaller than this IP address.
  - asRange
```
public abstract IPRange<IP> asRange()
```
    Returns an IP range containing only this IP address.
    
    Returns:
    
    An IP range containing only this IP address.
  - inSubnet
```
public abstract Subnet<IP> inSubnet(int prefixLength)
```
    Returns a subnet of a specific prefix length that contains this IP address.
    
    Parameters:
    
    prefixLength - The prefix length of the subnet to return.
    
    Returns:
    
    A subnet of the given prefix length that contains this IP address.
    
    Throws:
    
    IllegalArgumentException - If the prefix length is negative or larger than bits().
  - valueOf
```
public static IPAddress<?> valueOf(byte[] address)
```
    Returns an IP address from a byte array representation of the address.
    
    Parameters:
    
    address - The array to return an IP address for.
    
    Returns:
    
    An IP address that represents the given array.
    
    Throws:
    
    NullPointerException - If the given array is null.
    
    IllegalArgumentException - If the length of the given array is not 4 or 16.
  - valueOf
```
public static IPAddress<?> valueOf(CharSequence address)
```
    Returns an IP address represented by a CharSequence.
    
    Parameters:
    
    address - The IP address as a CharSequence.
    
    Returns:
    
    An IP address that represents the given address.
    
    Throws:
    
    NullPointerException - If the given CharSequence is null.
    
    IllegalArgumentException - If the given CharSequence does not represent a valid IP address.
  - valueOf
```
public static IPAddress<?> valueOf(CharSequence address,
                                   int start,
                                   int end)
```
    Returns an IP address represented by a portion of a CharSequence.
    
    Parameters:
    
    address - The IP address as a CharSequence.
    
    start - The index in the CharSequence where the IP address starts, inclusive.
    
    end - The index in the CharSequence where the IP address ends, exclusive.
    
    Returns:
    
    An IP address that represents the given address.
    
    Throws:
    
    NullPointerException - If the given CharSequence is null.
    
    IndexOutOfBoundsException - If the start index is negative, or if the end index is larger than the length of the CharSequence, or if the start index is larger than the end index.
    
    IllegalArgumentException - If the given CharSequence does not represent a valid IP address.
    
    Since:
    
    1.1
  - tryValueOf
```
public static Optional<IPAddress<?>> tryValueOf(CharSequence address)
```
    Attempts to return an IP address represented by a CharSequence.
    
    Parameters:
    
    address - The possible IP address as a CharSequence.
    
    Returns:
    
    An Optional with the IP address that represents the given address, or Optional.empty() if the given CharSequence is nullor does not represent a valid IP address.
  - tryValueOf
```
public static Optional<IPAddress<?>> tryValueOf(CharSequence address,
                                                int start,
                                                int end)
```
    Attempts to return an IP address represented by a portion of a CharSequence.
    
    Parameters:
    
    address - The possible IP address as a CharSequence.
    
    start - The index in the CharSequence where the IP address starts, inclusive.
    
    end - The index in the CharSequence where the IP address ends, exclusive.
    
    Returns:
    
    An Optional with the IP address that represents the given address, or Optional.empty() if the given CharSequence is nullor does not represent a valid IP address.
    
    Throws:
    
    IndexOutOfBoundsException - If the start index is negative, or if the end index is larger than the length of the CharSequence, or if the start index is larger than the end index (unless if the CharSequence is null).
    
    Since:
    
    1.1
  - valueOf
```
public static IPAddress<?> valueOf(InetAddress address)
```
    Returns an IP address represented by a InetAddress.
    
    Parameters:
    
    address - The IP address as a InetAddress.
    
    Returns:
    
    An IP address that represents the given address.
    
    Throws:
    
    NullPointerException - If the given InetAddress is null.
    
    IllegalArgumentException - If the given InetAddress is not supported.
  - isIPAddress
```
public static boolean isIPAddress(CharSequence s)
```
    Tests whether or not a CharSequence is a valid IP address.
    
    Parameters:
    
    s - The CharSequence to test.
    
    Returns:
    
    true if the CharSequence is a valid IP address, or false otherwise.
  - isIPAddress
```
public static boolean isIPAddress(CharSequence s,
                                  int start,
                                  int end)
```
    Tests whether or not a portion of a CharSequence is a valid IP address.
    
    Parameters:
    
    s - The CharSequence to test.
    
    start - The index in the CharSequence to start checking at, inclusive.
    
    end - The index in the CharSequence to end checking at, exclusive.
    
    Returns:
    
    true if the CharSequence is a valid IP address, or false otherwise.
    
    Throws:
    
    IndexOutOfBoundsException - If the start index is negative, or if the end index is larger than the length of the CharSequence, or if the start index is larger than the end index (unless if the CharSequence is null).
    
    Since:
    
    1.1
  - ifValidIPAddress
```
public static Predicate<CharSequence> ifValidIPAddress(Predicate<? super IPAddress<?>> predicate)
```
    Returns a predicate that checks whether or not CharSequences are valid IP addresses that match a specific predicate. This predicate can handle null values, which do not match the predicate.
    
    Parameters:
    
    predicate - The predicate to check if CharSequences are valid IP addresses.
    
    Returns:
    
    A predicate that checks whether or not CharSequences are valid IP addresses that match the given predicate.
    
    See Also:
    
    isIPAddress(CharSequence)

Class IPAddress<IP extends IPAddress<IP>>

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Comparable

Method Detail

bits

toByteArray

toInetAddress

equals

hashCode

toString

isMulticastAddress

isWildcardAddress

isLoopbackAddress

isLinkLocalAddress

isSiteLocalAddress

hasNext

next

hasPrevious

previous

to

asRange

inSubnet

valueOf

valueOf

valueOf

tryValueOf

tryValueOf

valueOf

isIPAddress

isIPAddress

ifValidIPAddress