IPv4Address

java.lang.Object
- inet.ipaddr.IPAddress
- - inet.ipaddr.ipv4.IPv4Address

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<IPAddress>, java.lang.Iterable<IPv4Address>
```
public class IPv4Address
extends IPAddress
implements java.lang.Iterable<IPv4Address>
```
An IPv4 address, or a subnet of multiple IPv4 addresses.

See Also:

Serialized Form

Core

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class IPv4Address.inet_aton_radix

static interface IPv4Address.IPv4AddressConverter
- Nested classes/interfaces inherited from class inet.ipaddr.IPAddress
  IPAddress.IPVersion

Nested Classes
Modifier and Type	Class and Description
`static class`	`IPv4Address.inet_aton_radix`
`static interface`	`IPv4Address.IPv4AddressConverter`

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`BIT_COUNT`
`static int`	`BITS_PER_SEGMENT`
`static int`	`BYTE_COUNT`
`static int`	`BYTES_PER_SEGMENT`
`static int`	`DEFAULT_TEXTUAL_RADIX`
`static int`	`MAX_STRING_LEN`
`static int`	`MAX_VALUE_PER_SEGMENT`
`static int`	`SEGMENT_COUNT`
`static char`	`SEGMENT_SEPARATOR`

Fields inherited from class inet.ipaddr.IPAddress
addressComparator, addressConverter, PREFIX_LEN_SEPARATOR, RANGE_SEPARATOR, RANGE_SEPARATOR_STR, SEGMENT_SQL_SINGLE_WILDCARD, SEGMENT_SQL_SINGLE_WILDCARD_STR, SEGMENT_SQL_WILDCARD, SEGMENT_SQL_WILDCARD_STR, SEGMENT_WILDCARD, SEGMENT_WILDCARD_STR

Constructor Summary

Constructors
Constructor and Description
`IPv4Address(byte[] bytes)` Constructs an IPv4 address.
`IPv4Address(byte[] bytes, java.lang.Integer networkPrefixLength)` Constructs an IPv4 address or subnet.
`IPv4Address(int address)` Constructs an IPv4 address.
`IPv4Address(int address, java.lang.Integer networkPrefixLength)` Constructs an IPv4 address or subnet.
`IPv4Address(IPv4AddressSection section)` Constructs an IPv4 address or subnet.
`IPv4Address(IPv4AddressSegment[] segments)` Constructs an IPv4 address or subnet.
`IPv4Address(IPv4AddressSegment[] segments, java.lang.Integer networkPrefixLength)` Constructs an IPv4 address or subnet.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.Iterable<IPv4Address>`	`getAddresses()`
`int`	`getBitCount()`
`int`	`getByteCount()`
`IPv4AddressSection`	`getHostSection()` Generates the host section of the address.
`IPv4AddressSection`	`getHostSection(int networkPrefixLength)` Generates the host section of the address.
`IPv6Address`	`getIPv4MappedAddress()`
`static IPv4Address`	`getLoopback()`
`IPv4Address`	`getLower()` If this represents an address with ranging values, returns an address representing the lower values of the range.
`IPv4AddressNetwork`	`getNetwork()`
`IPv4AddressSection`	`getNetworkSection()` Generates the network section of the address if the address is a CIDR prefix, otherwise it generates the entire address as a prefixed address with prefix matching the address bit length.
`IPv4AddressSection`	`getNetworkSection(int networkPrefixLength, boolean withPrefixLength)` Generates the network section of the address.
`IPAddressPart[]`	`getParts(IPAddressSection.IPStringBuilderOptions options)` Returns all the ways of breaking this address down into segments, as selected.
`IPAddressPart[]`	`getParts(IPv4AddressSection.IPv4StringBuilderOptions options)`
`IPv4AddressSection`	`getSection()` Returns the address as an address section comprising all segments in the address.
`IPv4AddressSegment`	`getSegment(int index)`
`int`	`getSegmentCount()`
`static java.lang.String[]`	`getStandardLoopbackStrings()`
`IPv4Address`	`getUpper()` If this represents an address with ranging values, returns an address representing the upper values of the range If this represents an address with a single value in each segment, returns this.
`boolean`	`isIPv4Convertible()` Determines whether this address can be converted to IPv4, if not IPv4 already.
`boolean`	`isIPv6Convertible()` Determines whether an address can be converted to IPv6, if not IPv6 already.
`boolean`	`isLinkLocal()`
`boolean`	`isLoopback()`
`boolean`	`isMulticast()`
`boolean`	`isSiteLocal()`
`java.util.Iterator<IPv4Address>`	`iterator()`
`static IPv4AddressNetwork`	`network()`
`IPv4Address[]`	`subtract(IPAddress other)` Subtract the give subnet from this subnet, returning an array of sections for the result (the subnets will not be contiguous so an array is required).
`IPAddressPartStringCollection`	`toAllStringCollection()`
`java.net.Inet4Address`	`toInetAddress()`
`java.lang.String`	`toInetAtonString(IPv4Address.inet_aton_radix radix)` Returns a string like the inet_aton style string
`java.lang.String`	`toInetAtonString(IPv4Address.inet_aton_radix radix, int joinedCount)`
`IPv4Address`	`toIPv4()` If this address is IPv4, or can be converted to IPv4, returns that `IPv4Address`.
`IPv6Address`	`toIPv6()` Returns this address converted to IPv6.
`java.lang.String`	`toReverseDNSLookupString()` Generates the reverse DNS lookup string For 8.255.4.4 it is 4.4.255.8.in-addr.arpa For 2001:db8::567:89ab it is b.a.9.8.7.6.5.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.8.b.d.0.1.0.0.2.ip6.arpa
`IPAddressPartStringCollection`	`toStandardStringCollection()`
`IPAddressPartStringCollection`	`toStringCollection(IPAddressSection.IPStringBuilderOptions opts)`
`IPAddressPartStringCollection`	`toStringCollection(IPv4AddressSection.IPv4StringBuilderOptions opts)`
`IPv4Address`	`toSubnet(int networkPrefixLength)` Creates a subnet address using the given CIDR prefix bits.
`IPv4Address`	`toSubnet(IPAddress mask)` Creates a subnet address using the given mask.
`IPv4Address`	`toSubnet(IPAddress mask, java.lang.Integer networkPrefixLength)` Creates a subnet address using the given mask.
`java.lang.String`	`toUNCHostName()` Generates the Microsoft UNC path component for this address

Methods inherited from class inet.ipaddr.IPAddress
bitCount, bitsPerSegment, byteCount, compareTo, contains, equals, from, from, from, from, getBitsPerSegment, getByteIndex, getBytes, getBytesPerSegment, getCount, getEquivalentPrefix, getIPVersion, getLocalHost, getLoopback, getLowestBytes, getMaskPrefixLength, getMatchesSQLClause, getMatchesSQLClause, getMaxSegmentValue, getMinPrefix, getNetworkPrefixLength, getNetworkSection, getSegmentIndex, getSegmentStrings, getStandardLoopbackStrings, hashCode, isAnyLocal, isIPv4, isIPv6, isMaskCompatibleWithRange, isMultiple, isMultipleByNetworkPrefix, isPrefixed, isRangeEquivalentToPrefix, isSameAddress, isZero, matches, maxSegmentValue, network, segmentCount, toAddressString, toAllStrings, toCanonicalHostName, toCanonicalString, toCanonicalWildcardString, toCompressedString, toCompressedWildcardString, toConvertedString, toDelimitedSQLStrs, toFullString, toHexString, toHostName, toNetworkPrefixLengthString, toNormalizedString, toNormalizedString, toNormalizedWildcardString, toPrefixedEquivalent, toPrefixedMin, toSQLWildcardString, toStandardStrings, toString, toStrings, toSubnetString, toSupernet, toSupernet

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

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Field Detail
  - SEGMENT_SEPARATOR
```
public static final char SEGMENT_SEPARATOR
```
    See Also:
    
    Constant Field Values
  - BITS_PER_SEGMENT
```
public static final int BITS_PER_SEGMENT
```
    See Also:
    
    Constant Field Values
  - BYTES_PER_SEGMENT
```
public static final int BYTES_PER_SEGMENT
```
    See Also:
    
    Constant Field Values
  - SEGMENT_COUNT
```
public static final int SEGMENT_COUNT
```
    See Also:
    
    Constant Field Values
  - BYTE_COUNT
```
public static final int BYTE_COUNT
```
    See Also:
    
    Constant Field Values
  - BIT_COUNT
```
public static final int BIT_COUNT
```
    See Also:
    
    Constant Field Values
  - DEFAULT_TEXTUAL_RADIX
```
public static final int DEFAULT_TEXTUAL_RADIX
```
    See Also:
    
    Constant Field Values
  - MAX_STRING_LEN
```
public static final int MAX_STRING_LEN
```
    See Also:
    
    Constant Field Values
  - MAX_VALUE_PER_SEGMENT
```
public static final int MAX_VALUE_PER_SEGMENT
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - IPv4Address
```
public IPv4Address(IPv4AddressSegment[] segments,
                   java.lang.Integer networkPrefixLength)
```
    Constructs an IPv4 address or subnet. When networkPrefixLength is non-null, this object represents a network prefix or the set of addresses with the same network prefix (a network or subnet, in other words).
    
    Parameters:
    
    segments - the address segments
    
    networkPrefixLength -
    
    Throws:
    
    java.lang.IllegalArgumentException - if segments is not length 4
  - IPv4Address
```
public IPv4Address(IPv4AddressSegment[] segments)
```
    Constructs an IPv4 address or subnet.
    
    Parameters:
    
    segments - the address segments
    
    Throws:
    
    java.lang.IllegalArgumentException - if segments is not length 4
  - IPv4Address
```
public IPv4Address(IPv4AddressSection section)
```
    Constructs an IPv4 address or subnet.
    
    Parameters:
    
    section - the address segments
    
    Throws:
    
    java.lang.IllegalArgumentException - if section does not have 4 segments
  - IPv4Address
```
public IPv4Address(int address)
```
    Constructs an IPv4 address.
    
    Parameters:
    
    address - the 4 byte IPv4 address
  - IPv4Address
```
public IPv4Address(int address,
                   java.lang.Integer networkPrefixLength)
```
    Constructs an IPv4 address or subnet. When networkPrefixLength is non-null, this object represents a network prefix or the set of addresses with the same network prefix (a network or subnet, in other words).
    
    Parameters:
    
    address - the 4 byte IPv4 address
    
    networkPrefixLength - the CIDR network prefix length, which can be null for no prefix
  - IPv4Address
```
public IPv4Address(byte[] bytes)
```
    Constructs an IPv4 address.
    
    Parameters:
    
    bytes - must be a 4 byte IPv4 address
    
    Throws:
    
    java.lang.IllegalArgumentException - if bytes is not length 4
  - IPv4Address
```
public IPv4Address(byte[] bytes,
                   java.lang.Integer networkPrefixLength)
```
    Constructs an IPv4 address or subnet. When networkPrefixLength is non-null, this object represents a network prefix or the set of addresses with the same network prefix (a network or subnet, in other words).
    
    Parameters:
    
    bytes - must be a 4 byte IPv4 address
    
    networkPrefixLength - the CIDR network prefix length, which can be null for no prefix
    
    Throws:
    
    java.lang.IllegalArgumentException - if bytes is not length 4
- Method Detail
  - getSection
```
public IPv4AddressSection getSection()
```
    Description copied from class: IPAddress
    
    Returns the address as an address section comprising all segments in the address.
    
    Overrides:
    
    getSection in class IPAddress
    
    Returns:
  - getSegment
```
public IPv4AddressSegment getSegment(int index)
```
    Overrides:
    
    getSegment in class IPAddress
  - getParts
```
public IPAddressPart[] getParts(IPAddressSection.IPStringBuilderOptions options)
```
    Description copied from class: IPAddress
    
    Returns all the ways of breaking this address down into segments, as selected.
    
    Overrides:
    
    getParts in class IPAddress
    
    Returns:
  - getParts
```
public IPAddressPart[] getParts(IPv4AddressSection.IPv4StringBuilderOptions options)
```
  - getSegmentCount
```
public int getSegmentCount()
```
    Specified by:
    
    getSegmentCount in class IPAddress
  - getByteCount
```
public int getByteCount()
```
    Specified by:
    
    getByteCount in class IPAddress
  - getBitCount
```
public int getBitCount()
```
    Specified by:
    
    getBitCount in class IPAddress
  - toIPv4
```
public IPv4Address toIPv4()
```
    Description copied from class: IPAddress
    
    If this address is IPv4, or can be converted to IPv4, returns that IPv4Address. Otherwise, returns null.
    
    Overrides:
    
    toIPv4 in class IPAddress
    
    Returns:
    
    the address
    
    See Also:
    
    IPAddress.isIPv4Convertible()
  - isIPv4Convertible
```
public boolean isIPv4Convertible()
```
    Description copied from class: IPAddress
    
    Determines whether this address can be converted to IPv4, if not IPv4 already. Override this method to convert in your own way, or call setAddressConverter with your own converter object. You should also override IPAddress.toIPv4() to match the conversion. This method returns true for all IPv4 addresses.
    
    Specified by:
    
    isIPv4Convertible in class IPAddress
    
    Returns:
  - getIPv4MappedAddress
```
public IPv6Address getIPv4MappedAddress()
```
  - isIPv6Convertible
```
public boolean isIPv6Convertible()
```
    Description copied from class: IPAddress
    
    Determines whether an address can be converted to IPv6, if not IPv6 already. Override this method to convert in your own way, or call setAddressConverter with your own converter object. You should also override IPAddress.toIPv6() to match the conversion. This method returns true for all IPv6 addresses.
    
    Specified by:
    
    isIPv6Convertible in class IPAddress
    
    Returns:
    
    See Also:
    
    toIPv6()
  - toIPv6
```
public IPv6Address toIPv6()
```
    Returns this address converted to IPv6.
    This uses isIPv6Convertible() to determine convertibility, and that uses an instance of IPAddressConverter.DefaultAddressConverter which uses IPv4-mapped address mappings from rfc 4038.
    Override this method and IPv6Address.isIPv4Convertible() if you wish to map IPv4 to IPv6 according to the mappings defined by in IPv6Address.isIPv4Compatible(), IPv6Address.isIPv4Mapped(), IPv6Address.is6To4() or some other mapping.
    If you override this method, you should also override the isIPv6Convertible() method to match this behaviour, and potentially also override the reverse conversion IPv6Address.toIPv4() in your IPv6Address subclass.
    
    Overrides:
    
    toIPv6 in class IPAddress
    
    Returns:
    
    If this address is IPv6, or can be converted to IPv6, returns that IPv6Address. Otherwise, returns null.
  - getLower
```
public IPv4Address getLower()
```
    Description copied from class: IPAddress
    
    If this represents an address with ranging values, returns an address representing the lower values of the range. If this represents an address with a single value in each segment, returns this.
    
    Specified by:
    
    getLower in class IPAddress
    
    Returns:
  - getUpper
```
public IPv4Address getUpper()
```
    Description copied from class: IPAddress
    
    If this represents an address with ranging values, returns an address representing the upper values of the range If this represents an address with a single value in each segment, returns this.
    
    Specified by:
    
    getUpper in class IPAddress
    
    Returns:
  - iterator
```
public java.util.Iterator<IPv4Address> iterator()
```
    Specified by:
    
    iterator in interface java.lang.Iterable<IPv4Address>
    
    Specified by:
    
    iterator in class IPAddress
  - getAddresses
```
public java.lang.Iterable<IPv4Address> getAddresses()
```
    Specified by:
    
    getAddresses in class IPAddress
    
    Returns:
    
    an object to iterate over the individual addresses represented by this object.
  - network
```
public static IPv4AddressNetwork network()
```
  - getNetwork
```
public IPv4AddressNetwork getNetwork()
```
    Specified by:
    
    getNetwork in class IPAddress
  - getLoopback
```
public static IPv4Address getLoopback()
```
  - getStandardLoopbackStrings
```
public static java.lang.String[] getStandardLoopbackStrings()
```
  - subtract
```
public IPv4Address[] subtract(IPAddress other)
```
    Description copied from class: IPAddress
    
    Subtract the give subnet from this subnet, returning an array of sections for the result (the subnets will not be contiguous so an array is required). Computes the subnet difference, the set of addresses in this address section but not in the provided section.
    
    Specified by:
    
    subtract in class IPAddress
    
    Returns:
    
    the difference
  - toSubnet
```
public IPv4Address toSubnet(int networkPrefixLength)
                     throws IPAddressTypeException
```
    Description copied from class: IPAddress
    
    Creates a subnet address using the given CIDR prefix bits. Since no mask is applied to all of the addresses represented (as with the other toSubnet methods), any existing prefix or range remains the same before applying the additional prefix.
    
    Specified by:
    
    toSubnet in class IPAddress
    
    Throws:
    
    IPAddressTypeException
  - toSubnet
```
public IPv4Address toSubnet(IPAddress mask)
                     throws IPAddressTypeException
```
    Creates a subnet address using the given mask.
    
    Specified by:
    
    toSubnet in class IPAddress
    
    Throws:
    
    IPAddressTypeException
  - toSubnet
```
public IPv4Address toSubnet(IPAddress mask,
                            java.lang.Integer networkPrefixLength)
                     throws IPAddressTypeException
```
    Creates a subnet address using the given mask. If networkPrefixLength is non-null, applies the prefix length as well.
    
    Specified by:
    
    toSubnet in class IPAddress
    
    Throws:
    
    IPAddressTypeException
  - getNetworkSection
```
public IPv4AddressSection getNetworkSection(int networkPrefixLength,
                                            boolean withPrefixLength)
```
    Description copied from class: IPAddress
    
    Generates the network section of the address. The returned section will have only as many segments as needed to hold the network as indicated by networkPrefixLength. If withPrefixLength is true, it will have networkPrefixLength as its associated prefix length, unless this address already has a smaller prefix length, in which case the existing prefix length is retained.
    
    Specified by:
    
    getNetworkSection in class IPAddress
    
    withPrefixLength - whether the resulting section will have networkPrefixLength as the associated prefix length or not
    
    Returns:
  - getNetworkSection
```
public IPv4AddressSection getNetworkSection()
```
    Description copied from class: IPAddress
    
    Generates the network section of the address if the address is a CIDR prefix, otherwise it generates the entire address as a prefixed address with prefix matching the address bit length.
    
    Specified by:
    
    getNetworkSection in class IPAddress
    
    Returns:
  - getHostSection
```
public IPv4AddressSection getHostSection(int networkPrefixLength)
```
    Description copied from class: IPAddress
    
    Generates the host section of the address. The returned section will have only as many segments as needed to hold the host as indicated by cidrBits.
    
    Specified by:
    
    getHostSection in class IPAddress
    
    Returns:
  - getHostSection
```
public IPv4AddressSection getHostSection()
```
    Description copied from class: IPAddress
    
    Generates the host section of the address. The returned section will have only as many segments as needed as determined by the existing CIDR prefix length. If there is no CIDR prefix length, the host section will have 0 segments.
    
    Specified by:
    
    getHostSection in class IPAddress
    
    Returns:
  - toInetAddress
```
public java.net.Inet4Address toInetAddress()
```
    Overrides:
    
    toInetAddress in class IPAddress
  - isLinkLocal
```
public boolean isLinkLocal()
```
    Specified by:
    
    isLinkLocal in class IPAddress
    
    See Also:
    
    InetAddress.isLinkLocalAddress()
  - isSiteLocal
```
public boolean isSiteLocal()
```
    Specified by:
    
    isSiteLocal in class IPAddress
    
    See Also:
    
    InetAddress.isSiteLocalAddress()
  - isMulticast
```
public boolean isMulticast()
```
    Specified by:
    
    isMulticast in class IPAddress
    
    See Also:
    
    InetAddress.isMulticastAddress()
  - isLoopback
```
public boolean isLoopback()
```
    Specified by:
    
    isLoopback in class IPAddress
    
    See Also:
    
    InetAddress.isLoopbackAddress()
  - toInetAtonString
```
public java.lang.String toInetAtonString(IPv4Address.inet_aton_radix radix)
```
    Returns a string like the inet_aton style string
    
    Returns:
  - toInetAtonString
```
public java.lang.String toInetAtonString(IPv4Address.inet_aton_radix radix,
                                         int joinedCount)
```
  - toUNCHostName
```
public java.lang.String toUNCHostName()
```
    Description copied from class: IPAddress
    
    Generates the Microsoft UNC path component for this address
    
    Specified by:
    
    toUNCHostName in class IPAddress
    
    Returns:
  - toReverseDNSLookupString
```
public java.lang.String toReverseDNSLookupString()
```
    Description copied from class: IPAddress
    
    Generates the reverse DNS lookup string For 8.255.4.4 it is 4.4.255.8.in-addr.arpa For 2001:db8::567:89ab it is b.a.9.8.7.6.5.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.8.b.d.0.1.0.0.2.ip6.arpa
    
    Specified by:
    
    toReverseDNSLookupString in class IPAddress
    
    Returns:
  - toStandardStringCollection
```
public IPAddressPartStringCollection toStandardStringCollection()
```
    Overrides:
    
    toStandardStringCollection in class IPAddress
  - toAllStringCollection
```
public IPAddressPartStringCollection toAllStringCollection()
```
    Overrides:
    
    toAllStringCollection in class IPAddress
  - toStringCollection
```
public IPAddressPartStringCollection toStringCollection(IPAddressSection.IPStringBuilderOptions opts)
```
    Overrides:
    
    toStringCollection in class IPAddress
  - toStringCollection
```
public IPAddressPartStringCollection toStringCollection(IPv4AddressSection.IPv4StringBuilderOptions opts)
```

Nested classes/interfaces inherited from class inet.ipaddr.IPAddress

Fields inherited from class inet.ipaddr.IPAddress

Methods inherited from class inet.ipaddr.IPAddress

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

SEGMENT_SEPARATOR

BITS_PER_SEGMENT

BYTES_PER_SEGMENT

SEGMENT_COUNT

BYTE_COUNT

BIT_COUNT

DEFAULT_TEXTUAL_RADIX

MAX_STRING_LEN

MAX_VALUE_PER_SEGMENT

IPv4Address

IPv4Address

IPv4Address

IPv4Address

IPv4Address

IPv4Address

IPv4Address

getSection

getSegment

getParts

getParts

getSegmentCount

getByteCount

getBitCount

toIPv4

isIPv4Convertible

getIPv4MappedAddress

isIPv6Convertible

toIPv6

getLower

getUpper

iterator

getAddresses

network

getNetwork

getLoopback

getStandardLoopbackStrings

subtract

toSubnet

toSubnet

toSubnet

getNetworkSection

getNetworkSection

getHostSection

getHostSection

toInetAddress

isLinkLocal

isSiteLocal

isMulticast

isLoopback

toInetAtonString

toInetAtonString

toUNCHostName

toReverseDNSLookupString

toStandardStringCollection

toAllStringCollection

toStringCollection

toStringCollection