IPv4Address (ip-utils 1.3.2 API)

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

All Implemented Interfaces:

Comparable<IPv4Address>
```
public final class IPv4Address
extends IPAddress<IPv4Address>
```
Represents an IPv4 address. Immutable.

Author:

Rob Spoor

Field Summary

Fields
Modifier and Type	Field and Description
`static IPv4Address`	`LOCALHOST` An IPv4 address object for localhost, `127.0.0.1`.
`static IPv4Address`	`MAX_VALUE` The maximum IPv4 address object, `255.255.255.255`.
`static IPv4Address`	`MIN_VALUE` The minimum IPv4 address object, `0.0.0.0`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`IPv4Range`	`asRange()` Returns an IP range containing only this IP address.
`int`	`bits()` Returns the number of bits required to store the IP address, always `32`.
`int`	`compareTo(IPv4Address other)`
`boolean`	`equals(Object o)` Tests whether or not another object is equal to this IP address.
`static IPv4Address`	`getNetmask(int prefixLength)` Returns an IPv4 address for a specific net mask.
`int`	`hashCode()` Returns a hash code value for this IP address.
`boolean`	`hasNext()` Returns whether or not there is a next IP address.
`boolean`	`hasPrevious()` Returns whether or not there is a previous IP address.
`static Predicate<CharSequence>`	`ifValidIPv4Address(Predicate<? super IPv4Address> predicate)` Returns a predicate that checks whether or not `CharSequence`s are valid IPv4 addresses that match a specific predicate.
`IPv4Subnet`	`inSubnet(int prefixLength)` Returns a subnet of a specific prefix length that contains this IP address.
`static boolean`	`isIPv4Address(CharSequence s)` Tests whether or not a `CharSequence` is a valid IPv4 address.
`static boolean`	`isIPv4Address(CharSequence s, int start, int end)` Tests whether or not a portion of a `CharSequence` is a valid IPv4 address.
`boolean`	`isLinkLocalAddress()` Returns whether or not this IP address is a link local address.
`boolean`	`isLoopbackAddress()` Returns whether or not this IP address is a loopback address.
`boolean`	`isMulticastAddress()` Returns whether or not this IP address is an IP multicast address.
`boolean`	`isSiteLocalAddress()` Returns whether or not this IP address is a site local address.
`boolean`	`isValidNetmask()` Returns whether or not this IPv4 address would be a valid netmask.
`boolean`	`isWildcardAddress()` Returns whether or not this IP address is a wildcard address.
`IPv4Address`	`next()` Returns the next IP address if it exists.
`IPv4Address`	`previous()` Returns the previous IP address if it exists.
`IPv4Range`	`to(IPv4Address end)` Returns an IP range starting at this IP address and ending in another IP address.
`byte[]`	`toByteArray()` Returns a byte array representation of this IP address.
`IPv6Address`	`toIPv6()` Returns an IPv6 representation of this IPv4 address.
`static Optional<IPv4Address>`	`tryValueOfIPv4(CharSequence address)` Attempts to return an IPv4 address represented by a `CharSequence`.
`static Optional<IPv4Address>`	`tryValueOfIPv4(CharSequence address, int start, int end)` Attempts to return an IPv4 address represented by a portion of a `CharSequence`.
`static IPv4Address`	`valueOf(byte[] address)` Returns an IPv4 address from a byte array representation of the address.
`static IPv4Address`	`valueOf(CharSequence address)` Returns an IPv4 address represented by a `CharSequence`.
`static IPv4Address`	`valueOf(CharSequence address, int start, int end)` Returns an IPv4 address represented by a portion of a `CharSequence`.
`static IPv4Address`	`valueOf(Inet4Address address)` Returns an IPv4 address represented by a `Inet4Address`.
`static IPv4Address`	`valueOf(int octet1, int octet2, int octet3, int octet4)` Returns an IPv4 address from four octets.

Methods inherited from class com.github.robtimus.net.ip.IPAddress
ifValidIPAddress, isIPAddress, isIPAddress, toInetAddress, toString, tryValueOf, tryValueOf, valueOf

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

- Field Detail
  - LOCALHOST
```
public static final IPv4Address LOCALHOST
```
    An IPv4 address object for localhost, 127.0.0.1.
  - MIN_VALUE
```
public static final IPv4Address MIN_VALUE
```
    The minimum IPv4 address object, 0.0.0.0.
  - MAX_VALUE
```
public static final IPv4Address MAX_VALUE
```
    The maximum IPv4 address object, 255.255.255.255.
- Method Detail
  - bits
```
public int bits()
```
    Returns the number of bits required to store the IP address, always 32.
    
    Specified by:
    
    bits in class IPAddress<IPv4Address>
    
    Returns:
    
    The number of bits required to store the IP address.
  - toByteArray
```
public byte[] toByteArray()
```
    Description copied from class: IPAddress
    
    Returns a byte array representation of this IP address. Its size is equal to IPAddress.bits() divided by Byte.SIZE. Furthermore, the result is in network byte order; the highest order byte is in the first element.
    
    Specified by:
    
    toByteArray in class IPAddress<IPv4Address>
    
    Returns:
    
    A byte array representation of this IP address.
  - toIPv6
```
public IPv6Address toIPv6()
```
    Returns an IPv6 representation of this IPv4 address. This IPv6 address is equivalent to ::ffff:d.d.d.d, where d.d.d.d represents this IPv4 address.
    
    Returns:
    
    An IPv6 representation of this IPv4 address.
  - equals
```
public boolean equals(Object o)
```
    Description copied from class: IPAddress
    
    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 IPAddress.toByteArray().
    Implementations do not necessary need to use IPAddress.toByteArray(), as long as equal IP addresses also have equal byte array representations.
    
    Specified by:
    
    equals in class IPAddress<IPv4Address>
  - hashCode
```
public int hashCode()
```
    Description copied from class: IPAddress
    
    Returns a hash code value for this IP address.
    Implementations do not necessarily need to use IPAddress.toByteArray(), as long as the general contract as specified by Object.hashCode() is not violated.
    
    Specified by:
    
    hashCode in class IPAddress<IPv4Address>
  - compareTo
```
public int compareTo(IPv4Address other)
```
  - isMulticastAddress
```
public boolean isMulticastAddress()
```
    Returns whether or not this IP address is an IP multicast address. An IP multicast address is a Class D address, which means the first four bits of the address are 1110. In other words, this method returns whether or not the IP address is in range 224.0.0.0 through 239.255.255.255.
    
    Specified by:
    
    isMulticastAddress in class IPAddress<IPv4Address>
    
    Returns:
    
    true if this IP address is an IP multicast address, or false otherwise.
    
    See Also:
    
    Inet4Address.isMulticastAddress()
  - isWildcardAddress
```
public boolean isWildcardAddress()
```
    Returns whether or not this IP address is a wildcard address.
    
    Specified by:
    
    isWildcardAddress in class IPAddress<IPv4Address>
    
    Returns:
    
    true if this IP address is a wildcard address, or false otherwise.
    
    See Also:
    
    Inet4Address.isAnyLocalAddress()
  - isLoopbackAddress
```
public boolean isLoopbackAddress()
```
    Returns whether or not this IP address is a loopback address. A loopback address is any address in the 127.0.0.0/8 subnet.
    
    Specified by:
    
    isLoopbackAddress in class IPAddress<IPv4Address>
    
    Returns:
    
    true if this IP address is a loopback address, or false otherwise.
    
    See Also:
    
    Inet4Address.isLoopbackAddress()
  - isLinkLocalAddress
```
public boolean isLinkLocalAddress()
```
    Returns whether or not this IP address is a link local address. This method returns whether or not the IP address is in the 169.254.0.0/16 subnet.
    
    Specified by:
    
    isLinkLocalAddress in class IPAddress<IPv4Address>
    
    Returns:
    
    true if this IP address is a link local address, or false otherwise.
    
    See Also:
    
    Inet4Address.isLinkLocalAddress()
  - isSiteLocalAddress
```
public boolean isSiteLocalAddress()
```
    Returns whether or not this IP address is a site local address. This method returns whether or not the IP address is in the 10.0.0.0/8, 172.16.0.0/12 or 192.168.0.0/16 subnets.
    
    Specified by:
    
    isSiteLocalAddress in class IPAddress<IPv4Address>
    
    Returns:
    
    true if this IP address is a site local address, or false otherwise.
    
    See Also:
    
    Inet4Address.isSiteLocalAddress()
  - hasNext
```
public boolean hasNext()
```
    Description copied from class: IPAddress
    
    Returns whether or not there is a next IP address.
    
    Specified by:
    
    hasNext in class IPAddress<IPv4Address>
    
    Returns:
    
    true if there is a next IP address, or false otherwise.
  - next
```
public IPv4Address next()
```
    Description copied from class: IPAddress
    
    Returns the next IP address if it exists.
    
    Specified by:
    
    next in class IPAddress<IPv4Address>
    
    Returns:
    
    The next IP address.
    
    See Also:
    
    IPAddress.hasNext()
  - hasPrevious
```
public boolean hasPrevious()
```
    Description copied from class: IPAddress
    
    Returns whether or not there is a previous IP address.
    
    Specified by:
    
    hasPrevious in class IPAddress<IPv4Address>
    
    Returns:
    
    true if there is a previous IP address, or false otherwise.
  - previous
```
public IPv4Address previous()
```
    Description copied from class: IPAddress
    
    Returns the previous IP address if it exists.
    
    Specified by:
    
    previous in class IPAddress<IPv4Address>
    
    Returns:
    
    The previous IP address.
    
    See Also:
    
    IPAddress.hasPrevious()
  - to
```
public IPv4Range to(IPv4Address end)
```
    Description copied from class: IPAddress
    
    Returns an IP range starting at this IP address and ending in another IP address.
    
    Specified by:
    
    to in class IPAddress<IPv4Address>
    
    Parameters:
    
    end - The end of the IP range, inclusive.
    
    Returns:
    
    An IP range from this IP address to the given IP address.
  - asRange
```
public IPv4Range asRange()
```
    Description copied from class: IPAddress
    
    Returns an IP range containing only this IP address.
    
    Specified by:
    
    asRange in class IPAddress<IPv4Address>
    
    Returns:
    
    An IP range containing only this IP address.
  - inSubnet
```
public IPv4Subnet inSubnet(int prefixLength)
```
    Description copied from class: IPAddress
    
    Returns a subnet of a specific prefix length that contains this IP address.
    
    Specified by:
    
    inSubnet in class IPAddress<IPv4Address>
    
    Parameters:
    
    prefixLength - The prefix length of the subnet to return.
    
    Returns:
    
    A subnet of the given prefix length that contains this IP address.
  - valueOf
```
public static IPv4Address valueOf(int octet1,
                                  int octet2,
                                  int octet3,
                                  int octet4)
```
    Returns an IPv4 address from four octets. For example, valueOf(192, 168, 0, 1) will return an IPv4 address that represents 192.168.0.1.
    
    Parameters:
    
    octet1 - The first octet.
    
    octet2 - The second octet.
    
    octet3 - The third octet.
    
    octet4 - The fourth octet.
    
    Returns:
    
    An IPv4 address that represents the given octets.
    
    Throws:
    
    IllegalArgumentException - If any of the octets is not between 0 and 255, inclusive.
  - valueOf
```
public static IPv4Address valueOf(byte[] address)
```
    Returns an IPv4 address from a byte array representation of the address.
    
    Parameters:
    
    address - The array to return an IPv4 address for.
    
    Returns:
    
    An IPv4 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.
  - valueOf
```
public static IPv4Address valueOf(CharSequence address)
```
    Returns an IPv4 address represented by a CharSequence.
    
    Parameters:
    
    address - The IPv4 address as a CharSequence.
    
    Returns:
    
    An IPv4 address that represents the given address.
    
    Throws:
    
    NullPointerException - If the given CharSequence is null.
    
    IllegalArgumentException - If the given CharSequence does not represent a valid IPv4 address.
  - valueOf
```
public static IPv4Address valueOf(CharSequence address,
                                  int start,
                                  int end)
```
    Returns an IPv4 address represented by a portion of a CharSequence.
    
    Parameters:
    
    address - The IPv4 address as a CharSequence.
    
    start - The index in the CharSequence where the IPv4 address starts, inclusive.
    
    end - The index in the CharSequence where the IPv4 address ends, exclusive.
    
    Returns:
    
    An IPv4 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 IPv4 address.
    
    Since:
    
    1.1
  - tryValueOfIPv4
```
public static Optional<IPv4Address> tryValueOfIPv4(CharSequence address)
```
    Attempts to return an IPv4 address represented by a CharSequence.
    
    Parameters:
    
    address - The possible IPv4 address as a CharSequence.
    
    Returns:
    
    An Optional with the IPv4 address that represents the given address, or Optional.empty() if the given CharSequence is nullor does not represent a valid IPv4 address.
  - tryValueOfIPv4
```
public static Optional<IPv4Address> tryValueOfIPv4(CharSequence address,
                                                   int start,
                                                   int end)
```
    Attempts to return an IPv4 address represented by a portion of a CharSequence.
    
    Parameters:
    
    address - The possible IPv4 address as a CharSequence.
    
    start - The index in the CharSequence where the IPv4 address starts, inclusive.
    
    end - The index in the CharSequence where the IPv4 address ends, exclusive.
    
    Returns:
    
    An Optional with the IPv4 address that represents the given address, or Optional.empty() if the given CharSequence is nullor does not represent a valid IPv4 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 IPv4Address valueOf(Inet4Address address)
```
    Returns an IPv4 address represented by a Inet4Address.
    
    Parameters:
    
    address - The IPv4 address as a Inet4Address.
    
    Returns:
    
    An IPv4 address that represents the given address.
    
    Throws:
    
    NullPointerException - If the given Inet4Address is null.
  - getNetmask
```
public static IPv4Address getNetmask(int prefixLength)
```
    Returns an IPv4 address for a specific net mask.
    
    Parameters:
    
    prefixLength - The prefix length of the subnet for the net mask. For instance, 0 represents a net mask for /0 which is 0.0.0.0, 8 represents a net mask for a class A network /8 which is 255.0.0.0, 16 represents a net mask for a class B network /16 which is 255.255.0.0, 24 represents a net mask for a class C network /24 which is 255.255.255.0, etc.
    
    Returns:
    
    An IPv4 address representing a net mask with the given number of bits.
    
    Throws:
    
    IllegalArgumentException - If the number of bits is not between 0 and 32, inclusive.
  - isValidNetmask
```
public boolean isValidNetmask()
```
    Returns whether or not this IPv4 address would be a valid netmask. An IPv4 address would be a valid netmask if only its left-most bits are 1s.
    
    Returns:
    
    true if this IPv4 address would be a valid netmask, or false otherwise.
  - isIPv4Address
```
public static boolean isIPv4Address(CharSequence s)
```
    Tests whether or not a CharSequence is a valid IPv4 address.
    
    Parameters:
    
    s - The CharSequence to test.
    
    Returns:
    
    true if the CharSequence is a valid IP address, or false otherwise.
  - isIPv4Address
```
public static boolean isIPv4Address(CharSequence s,
                                    int start,
                                    int end)
```
    Tests whether or not a portion of a CharSequence is a valid IPv4 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
  - ifValidIPv4Address
```
public static Predicate<CharSequence> ifValidIPv4Address(Predicate<? super IPv4Address> predicate)
```
    Returns a predicate that checks whether or not CharSequences are valid IPv4 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:
    
    isIPv4Address(CharSequence)

Class IPv4Address

Field Summary

Method Summary

Methods inherited from class com.github.robtimus.net.ip.IPAddress

Methods inherited from class java.lang.Object

Field Detail

LOCALHOST

MIN_VALUE

MAX_VALUE

Method Detail

bits

toByteArray

toIPv6

equals

hashCode

compareTo

isMulticastAddress

isWildcardAddress

isLoopbackAddress

isLinkLocalAddress

isSiteLocalAddress

hasNext

next

hasPrevious

previous

to

asRange

inSubnet

valueOf

valueOf

valueOf

valueOf

tryValueOfIPv4

tryValueOfIPv4

valueOf

getNetmask

isValidNetmask

isIPv4Address

isIPv4Address

ifValidIPv4Address