IPv4Address

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

All Implemented Interfaces:

AddressComponent, AddressSegmentSeries, AddressDivisionSeries, AddressItem, AddressStringDivisionSeries, IPAddressSegmentSeries, java.io.Serializable, java.lang.Comparable<Address>, java.lang.Iterable<IPv4Address>
```
public class IPv4Address
extends IPAddress
implements java.lang.Iterable<IPv4Address>
```
An IPv4 address, or a subnet of multiple IPv4 addresses. Each segment can represent a single value or a range of values.
You can construct an IPv4 address from a byte array, from an int, from a Address.SegmentValueProvider, from Inet4Address, from an IPv4AddressSection of 4 segments, or from an array of 4 IPv4AddressSegment objects.
To construct one from a String use IPAddressString.toAddress() or IPAddressString.getAddress(), IPAddressString.toHostAddress() or IPAddressString.getHostAddress()

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/interfaces inherited from class inet.ipaddr.Address
  Address.AddressProvider, Address.SegmentValueProvider

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_VALUE_PER_SEGMENT`
`static java.lang.String`	`REVERSE_DNS_SUFFIX`
`static int`	`SEGMENT_COUNT`
`static char`	`SEGMENT_SEPARATOR`

Fields inherited from class inet.ipaddr.IPAddress
DEFAULT_ADDRESS_CONVERTER, PREFIX_LEN_SEPARATOR

Fields inherited from class inet.ipaddr.Address
ALTERNATIVE_RANGE_SEPARATOR, ALTERNATIVE_RANGE_SEPARATOR_STR, ALTERNATIVE_SEGMENT_WILDCARD_STR, DEFAULT_ADDRESS_COMPARATOR, HEX_PREFIX, OCTAL_PREFIX, 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(Address.SegmentValueProvider valueProvider)` Constructs an IPv4 address.
`IPv4Address(Address.SegmentValueProvider lowerValueProvider, Address.SegmentValueProvider upperValueProvider)` Constructs an IPv4 address or subnet.
`IPv4Address(Address.SegmentValueProvider lowerValueProvider, Address.SegmentValueProvider upperValueProvider, java.lang.Integer networkPrefixLength)` Constructs an IPv4 address or subnet.
`IPv4Address(Address.SegmentValueProvider valueProvider, java.lang.Integer networkPrefixLength)` Constructs an IPv4 address.
`IPv4Address(byte[] bytes)` Constructs an IPv4 address.
`IPv4Address(byte[] bytes, java.lang.Integer networkPrefixLength)` Constructs an IPv4 address or subnet.
`IPv4Address(byte[] bytes, int byteStartIndex, int byteEndIndex)` Constructs an IPv4 address or subnet.
`IPv4Address(byte[] bytes, int byteStartIndex, int byteEndIndex, java.lang.Integer networkPrefixLength)` Constructs an IPv4 address or subnet.
`IPv4Address(java.net.Inet4Address inet4Address)` Constructs an IPv4 address.
`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
`IPv4Address`	`adjustPrefixBySegment(boolean nextSegment)` Increases or decreases prefix length to the next segment boundary.
`IPv4Address`	`adjustPrefixBySegment(boolean nextSegment, boolean zeroed)` Increases or decreases prefix length to the next segment boundary.
`IPv4Address`	`adjustPrefixLength(int adjustment)` Increases or decreases prefix length by the given increment.
`IPv4Address`	`adjustPrefixLength(int adjustment, boolean zeroed)` Increases or decreases prefix length by the given increment.
`IPv4Address`	`applyPrefixLength(int networkPrefixLength)` Applies the given prefix length to create a new segment series.
`IPv4Address`	`assignMinPrefixForBlock()` Constructs an equivalent address with the smallest CIDR prefix possible (largest network), such that the range of values are a set of subnet blocks for that prefix.
`IPv4Address`	`assignPrefixForSingleBlock()` Returns the equivalent CIDR address with a prefix length for which the address subnet block matches the range of values in this address.
`IPv4Address`	`bitwiseOr(IPAddress mask)` Equivalent to calling `IPAddress.bitwiseOr(IPAddress, boolean)` with the second argument as false.
`IPv4Address`	`bitwiseOr(IPAddress mask, boolean retainPrefix)` Does the bitwise disjunction with this address.
`IPv4Address`	`bitwiseOrNetwork(IPAddress mask, int networkPrefixLength)` Does the bitwise disjunction with this address.
`int`	`getBitCount()`
`int`	`getByteCount()` returns the number of bytes in each of the address components represented by this instance
`IPv4AddressSegment`	`getDivision(int index)`
`IPv4AddressSection`	`getHostSection()` Returns the host section of the series.
`IPv4AddressSection`	`getHostSection(int networkPrefixLength)` Returns the host section of the address as indicated by the network prefix length provided.
`IPv6Address`	`getIPv4MappedAddress()`
`IPv6Address`	`getIPv6Address(IPv6AddressSegment[] segs)` Create an IPv6 mixed address using the given ipv6 segments and using this address for the embedded IPv4 segments
`IPv6AddressNetwork`	`getIPv6Network()`
`java.lang.Iterable<IPv4Address>`	`getIterable()` Useful for using an instance in a "for-each loop".
`IPv4Address`	`getLower()` If this represents a series with ranging values, returns a series representing the lower values of the range.
`IPv4Address`	`getLowerNonZeroHost()` Similar to `IPAddressSegmentSeries.getLower()`, but will not return a series that has a prefix length and whose host value is zero.
`IPv4AddressNetwork`	`getNetwork()` Returns the network object for series of the same version (eg IPv4, IPv6 and MAC each have their own network object)
`IPv4AddressSection`	`getNetworkSection()` Returns the network section of the series if the series has a CIDR network prefix length, otherwise it returns the entire series as a prefixed series with prefix matching the address bit length.
`IPv4AddressSection`	`getNetworkSection(int networkPrefixLength)` Returns the network section of the series.
`IPv4AddressSection`	`getNetworkSection(int networkPrefixLength, boolean withPrefixLength)` Returns the network section of the series.
`IPAddressStringDivisionSeries[]`	`getParts(IPAddressSection.IPStringBuilderOptions options)` Returns all the ways of breaking this address down into segments, as selected.
`IPAddressStringDivisionSeries[]`	`getParts(IPv4AddressSection.IPv4StringBuilderOptions options)`
`IPv4AddressSection`	`getSection()` Returns the address as an address section comprising all segments in the address.
`IPv4AddressSection`	`getSection(int index)` Gets the subsection from the series starting from the given index
`IPv4AddressSection`	`getSection(int index, int endIndex)` Gets the subsection from the series starting from the given index and ending just before the give endIndex
`IPv4AddressSegment`	`getSegment(int index)` Returns the segment from this series at the given index.
`int`	`getSegmentCount()` Returns the number of segments in this series.
`IPv4AddressSegment[]`	`getSegments()` Returns the segments of this series of segments as an array.
`IPv4Address`	`getUpper()` If this represents a series with ranging values, returns a series representing the upper values of the range If this represents a series with a single value in each segment, returns this.
`IPv4Address`	`increment(long increment)` Returns the series from the subnet that is the given increment upwards into the subnet range, or if the given increment is negative the given increment downwards into the subnet range, or if this is just an individual series, it simply adds the increment to this.
`IPv4Address`	`intersect(IPAddress other)` Produces the subnet whose addresses are found in both this and the given subnet argument.
`int`	`intValue()`
`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()` Returns whether the address is link local, whether unicast or multicast.
`boolean`	`isLocal()` Returns true if the address is link local, site local, organization local, administered locally, or unspecified.
`boolean`	`isLoopback()`
`boolean`	`isMulticast()` Whether the MAC address or IP address or other form of address is multicast.
`boolean`	`isPrivate()` Unicast addresses allocated for private use
`java.util.Iterator<IPv4Address>`	`iterator()` Iterates through the individual segment series.
`long`	`longValue()`
`IPv4Address`	`mask(IPAddress mask)` Equivalent to calling `IPAddress.mask(IPAddress, boolean)` with the second argument as false.
`IPv4Address`	`mask(IPAddress mask, boolean retainPrefix)` Applies the given mask to all addresses represented by this IPAddress.
`IPv4Address`	`maskNetwork(IPAddress mask, int networkPrefixLength)` Applies the given mask to all addresses represented by this IPAddress while also applying the given prefix length at the same time.
`IPv4Address[]`	`mergePrefixBlocks(IPAddress... addresses)` Merges this with the list of addresses to produce the smallest list of prefix blocks
`java.util.Iterator<IPv4Address>`	`nonZeroHostIterator()`
`java.util.Iterator<IPv4Address>`	`prefixBlockIterator()` Iterates through the individual prefix blocks.
`IPv4Address`	`removePrefixLength()` Removes the prefix length.
`IPv4Address`	`removePrefixLength(boolean zeroed)` Removes the prefix length.
`IPv4Address`	`replace(int startIndex, int endIndex, IPv4Address replacement, int replacementIndex)` Replaces segments starting from startIndex and ending before endIndex with the same number of segments starting at replacementStartIndex from the replacement section
`IPv4Address`	`reverseBits(boolean perByte)` Returns a new segment series with the bits reversed.
`IPv4Address`	`reverseBytes()` Returns a new segment series with the bytes reversed.
`IPv4Address`	`reverseBytesPerSegment()` Returns a new segment series with the bytes reversed within each segment.
`IPv4Address`	`reverseSegments()` Returns a new segment series with the segments reversed.
`java.util.Iterator<IPv4AddressSegment[]>`	`segmentsIterator()` Iterates through the individual segments.
`java.util.Iterator<IPv4AddressSegment[]>`	`segmentsNonZeroHostIterator()`
`IPv4Address`	`setPrefixLength(int prefixLength)` Sets the prefix length.
`IPv4Address`	`setPrefixLength(int prefixLength, boolean zeroed)` Sets the prefix length.
`IPv4Address[]`	`spanWithPrefixBlocks(IPAddress other)` Produces the list of prefix block subnets that span from this series to the given series.
`IPv4Address[]`	`subtract(IPAddress other)` Subtract the given subnet from this subnet, returning an array of subnets for the result (the subnets will not be contiguous so an array is required).
`IPAddressPartStringCollection`	`toAllStringCollection()`
`IPv4Address`	`toBroadcastAddress()`
`java.net.Inet4Address`	`toInetAddress()` Converts the lowest value of this address to an InetAddress
`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.
`IPv4Address`	`toMaxHost()` Returns the segment series with a host of all ones.
`IPv4Address`	`toMaxHost(int prefixLength)` Produces the series with host values of all one bits for the given prefix length.
`IPv4Address`	`toNetworkAddress()`
`static java.lang.String`	`toNormalizedString(IPv4AddressNetwork network, Address.SegmentValueProvider lowerValueProvider, Address.SegmentValueProvider upperValueProvider, java.lang.Integer prefixLength)` Creates the normalized string for an address without having to create the address objects first.
`IPv4Address`	`toPrefixBlock()` Returns the subnet associated with the prefix length of this address.
`IPv4Address`	`toPrefixBlock(int networkPrefixLength)` Returns the segment series of the same length that spans all hosts.
`IPAddressPartStringCollection`	`toStandardStringCollection()`
`IPAddressPartStringCollection`	`toStringCollection(IPAddressSection.IPStringBuilderOptions opts)`
`IPAddressPartStringCollection`	`toStringCollection(IPv4AddressSection.IPv4StringBuilderOptions opts)`
`java.lang.String`	`toUNCHostName()` Generates the Microsoft UNC path component for this address
`java.net.Inet4Address`	`toUpperInetAddress()` Converts the highest value of this address to an InetAddress.
`IPv4Address`	`toZeroHost()` Returns the segment series with a host of zero.
`IPv4Address`	`toZeroHost(int prefixLength)` Produces the series with host values of 0 for the given prefix length.
`int`	`upperIntValue()`
`long`	`upperLongValue()`

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

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

Methods inherited from interface inet.ipaddr.AddressSegmentSeries
getSegments, getSegments, getSegmentStrings, toCanonicalString, toCompressedString

Methods inherited from interface inet.ipaddr.format.AddressDivisionSeries
containsPrefixBlock, containsSinglePrefixBlock, getDivisionStrings, getMinPrefixLengthForBlock, getPrefixCount, getPrefixLength, getPrefixLengthForSingleBlock, getUpperValue, getValue, isMore, isPrefixBlock, isPrefixed, isSinglePrefixBlock

Methods inherited from interface inet.ipaddr.format.AddressStringDivisionSeries
getDivisionCount

Methods inherited from interface inet.ipaddr.AddressComponent
toHexString, toNormalizedString

Methods inherited from interface inet.ipaddr.format.AddressItem
getBytes, getBytes, getCount, getUpperBytes, getUpperBytes, includesMax, includesZero, isFullRange, isMax, isMultiple, isZero

- 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_VALUE_PER_SEGMENT
```
public static final int MAX_VALUE_PER_SEGMENT
```
    See Also:
    
    Constant Field Values
  - REVERSE_DNS_SUFFIX
```
public static final java.lang.String REVERSE_DNS_SUFFIX
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - IPv4Address
```
public IPv4Address(IPv4AddressSegment[] segments)
            throws AddressValueException
```
    Constructs an IPv4 address or subnet.
    
    Parameters:
    
    segments - the address segments
    
    Throws:
    
    AddressValueException - if segments is not length 4
  - IPv4Address
```
public IPv4Address(IPv4AddressSegment[] segments,
                   java.lang.Integer networkPrefixLength)
            throws AddressValueException
```
    Constructs an IPv4 address or subnet.
    When networkPrefixLength is non-null, depending on the prefix configuration (see AddressNetwork.getPrefixConfiguration(), this object may represent either a single address with that network prefix length, or the prefix subnet block containing all addresses with the same network prefix.
    
    Parameters:
    
    segments - the address segments
    
    networkPrefixLength -
    
    Throws:
    
    AddressValueException - if segments is not length 4
  - IPv4Address
```
public IPv4Address(IPv4AddressSection section)
            throws AddressValueException
```
    Constructs an IPv4 address or subnet.
    
    Parameters:
    
    section - the address segments
    
    Throws:
    
    AddressValueException - 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)
            throws AddressValueException
```
    Constructs an IPv4 address or subnet.
    When networkPrefixLength is non-null, depending on the prefix configuration (see AddressNetwork.getPrefixConfiguration(), this object may represent either a single address with that network prefix length, or the prefix subnet block containing all addresses with the same network prefix.
    
    Parameters:
    
    address - the 4 byte IPv4 address
    
    networkPrefixLength - the CIDR network prefix length, which can be null for no prefix
    
    Throws:
    
    AddressValueException
  - IPv4Address
```
public IPv4Address(java.net.Inet4Address inet4Address)
```
    Constructs an IPv4 address.
    
    Parameters:
    
    inet4Address - the java.net address object
  - IPv4Address
```
public IPv4Address(byte[] bytes)
            throws AddressValueException
```
    Constructs an IPv4 address.
    
    Parameters:
    
    bytes - the 4 byte IPv4 address in network byte order - if longer than 4 bytes the additional bytes must be zero, if shorter than 4 bytes then then the bytes are sign-extended to 4 bytes.
    
    Throws:
    
    AddressValueException - if bytes not equivalent to a 4 byte address
  - IPv4Address
```
public IPv4Address(byte[] bytes,
                   int byteStartIndex,
                   int byteEndIndex)
            throws AddressValueException
```
    Constructs an IPv4 address or subnet.
    Similar to IPv4Address(byte[]) except that you can specify the start and end of the address in the given byte array.
    
    Parameters:
    
    bytes -
    
    Throws:
    
    AddressValueException
  - IPv4Address
```
public IPv4Address(byte[] bytes,
                   java.lang.Integer networkPrefixLength)
            throws AddressValueException
```
    Constructs an IPv4 address or subnet.
    When networkPrefixLength is non-null, depending on the prefix configuration (see AddressNetwork.getPrefixConfiguration(), this object may represent either a single address with that network prefix length, or the prefix subnet block containing all addresses with the same network prefix.
    
    Parameters:
    
    bytes - the 4 byte IPv4 address in network byte order - if longer than 4 bytes the additional bytes must be zero, if shorter than 4 bytes then the bytes are sign-extended to 4 bytes.
    
    networkPrefixLength - the CIDR network prefix length, which can be null for no prefix
    
    Throws:
    
    AddressValueException - if bytes not equivalent to a 4 byte address
  - IPv4Address
```
public IPv4Address(byte[] bytes,
                   int byteStartIndex,
                   int byteEndIndex,
                   java.lang.Integer networkPrefixLength)
            throws AddressValueException
```
    Constructs an IPv4 address or subnet.
    Similar to IPv4Address(byte[],Integer) except that you can specify the start and end of the address in the given byte array.
    When networkPrefixLength is non-null, depending on the prefix configuration (see AddressNetwork.getPrefixConfiguration(), this object may represent either a single address with that network prefix length, or the prefix subnet block containing all addresses with the same network prefix.
    
    Parameters:
    
    bytes - the 4 byte IPv4 address - if longer than 4 bytes the additional bytes must be zero, if shorter than 4 bytes then the bytes are sign-extended to 4 bytes.
    
    networkPrefixLength - the CIDR network prefix length, which can be null for no prefix
    
    Throws:
    
    AddressValueException - if bytes not equivalent to a 4 byte address
  - IPv4Address
```
public IPv4Address(Address.SegmentValueProvider lowerValueProvider,
                   Address.SegmentValueProvider upperValueProvider,
                   java.lang.Integer networkPrefixLength)
            throws AddressValueException
```
    Constructs an IPv4 address or subnet.
    When networkPrefixLength is non-null, depending on the prefix configuration (see AddressNetwork.getPrefixConfiguration(), this object may represent either a single address with that network prefix length, or the prefix subnet block containing all addresses with the same network prefix.
    
    Parameters:
    
    lowerValueProvider - supplies the 1 byte lower values for each segment
    
    upperValueProvider - supplies the 1 byte upper values for each segment
    
    networkPrefixLength - the CIDR network prefix length, which can be null for no prefix
    
    Throws:
    
    AddressValueException
  - IPv4Address
```
public IPv4Address(Address.SegmentValueProvider lowerValueProvider,
                   Address.SegmentValueProvider upperValueProvider)
```
    Constructs an IPv4 address or subnet.
    
    Parameters:
    
    lowerValueProvider - supplies the 1 byte lower values for each segment
    
    upperValueProvider - supplies the 1 byte upper values for each segment
  - IPv4Address
```
public IPv4Address(Address.SegmentValueProvider valueProvider,
                   java.lang.Integer networkPrefixLength)
            throws AddressValueException
```
    Constructs an IPv4 address.
    When networkPrefixLength is non-null, depending on the prefix configuration (see AddressNetwork.getPrefixConfiguration(), this object may represent either a single address with that network prefix length, or the prefix subnet block containing all addresses with the same network prefix.
    
    Parameters:
    
    valueProvider - supplies the 1 byte value for each segment
    
    networkPrefixLength - the CIDR network prefix length, which can be null for no prefix
    
    Throws:
    
    AddressValueException
  - IPv4Address
```
public IPv4Address(Address.SegmentValueProvider valueProvider)
```
    Constructs an IPv4 address.
    
    Parameters:
    
    valueProvider - supplies the 1 byte value for each segment
- Method Detail
  - getSection
```
public IPv4AddressSection getSection()
```
    Description copied from class: IPAddress
    
    Returns the address as an address section comprising all segments in the address.
    
    Specified by:
    
    getSection in interface AddressSegmentSeries
    
    Specified by:
    
    getSection in interface IPAddressSegmentSeries
    
    Overrides:
    
    getSection in class IPAddress
    
    Returns:
  - getSection
```
public IPv4AddressSection getSection(int index)
```
    Description copied from interface: AddressSegmentSeries
    
    Gets the subsection from the series starting from the given index
    
    Specified by:
    
    getSection in interface AddressSegmentSeries
    
    Specified by:
    
    getSection in interface IPAddressSegmentSeries
    
    Overrides:
    
    getSection in class IPAddress
    
    Returns:
  - getSection
```
public IPv4AddressSection getSection(int index,
                                     int endIndex)
```
    Description copied from interface: AddressSegmentSeries
    
    Gets the subsection from the series starting from the given index and ending just before the give endIndex
    
    Specified by:
    
    getSection in interface AddressSegmentSeries
    
    Specified by:
    
    getSection in interface IPAddressSegmentSeries
    
    Overrides:
    
    getSection in class IPAddress
    
    Returns:
  - getDivision
```
public IPv4AddressSegment getDivision(int index)
```
    Specified by:
    
    getDivision in interface AddressDivisionSeries
    
    Specified by:
    
    getDivision in interface AddressStringDivisionSeries
    
    Returns:
    
    the given division in this series. The first is at index 0.
  - getSegment
```
public IPv4AddressSegment getSegment(int index)
```
    Description copied from interface: AddressSegmentSeries
    
    Returns the segment from this series at the given index.
    
    Specified by:
    
    getSegment in interface AddressSegmentSeries
    
    Specified by:
    
    getSegment in interface IPAddressSegmentSeries
    
    Returns:
  - getSegments
```
public IPv4AddressSegment[] getSegments()
```
    Description copied from interface: AddressSegmentSeries
    
    Returns the segments of this series of segments as an array. This must create a new array, so for efficiency use AddressSegmentSeries.getSegment(int) and AddressSegmentSeries.getSegmentCount() instead when feasible.
    
    Specified by:
    
    getSegments in interface AddressSegmentSeries
    
    Specified by:
    
    getSegments in interface IPAddressSegmentSeries
    
    Returns:
  - getParts
```
public IPAddressStringDivisionSeries[] 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 IPAddressStringDivisionSeries[] getParts(IPv4AddressSection.IPv4StringBuilderOptions options)
```
  - getSegmentCount
```
public int getSegmentCount()
```
    Description copied from interface: AddressSegmentSeries
    
    Returns the number of segments in this series.
    
    Specified by:
    
    getSegmentCount in interface AddressSegmentSeries
    
    Overrides:
    
    getSegmentCount in class Address
    
    Returns:
  - getByteCount
```
public int getByteCount()
```
    Description copied from interface: AddressComponent
    
    returns the number of bytes in each of the address components represented by this instance
    
    Specified by:
    
    getByteCount in interface AddressComponent
    
    Overrides:
    
    getByteCount in class IPAddress
    
    Returns:
  - getBitCount
```
public int getBitCount()
```
    Specified by:
    
    getBitCount in interface AddressItem
    
    Overrides:
    
    getBitCount in class Address
    
    Returns:
    
    the number of bits comprising this address item
  - 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. If IPv6, the default behaviour is to convert by IPv4 mapping, see IPv6Address.isIPv4Mapped() 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:
  - getIPv6Address
```
public IPv6Address getIPv6Address(IPv6AddressSegment[] segs)
```
    Create an IPv6 mixed address using the given ipv6 segments and using this address for the embedded IPv4 segments
    
    Parameters:
    
    segs -
    
    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. The default behaviour is to convert by IPv4 mapping, see getIPv4MappedAddress() 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.
    
    See Also:
    
    IPAddress.isIPv6Convertible()
  - toBroadcastAddress
```
public IPv4Address toBroadcastAddress()
```
  - toNetworkAddress
```
public IPv4Address toNetworkAddress()
```
  - getLowerNonZeroHost
```
public IPv4Address getLowerNonZeroHost()
```
    Description copied from interface: IPAddressSegmentSeries
    
    Similar to IPAddressSegmentSeries.getLower(), but will not return a series that has a prefix length and whose host value is zero. If this series has no prefix length, returns the same series as IPAddressSegmentSeries.getLower().
    
    Specified by:
    
    getLowerNonZeroHost in interface IPAddressSegmentSeries
    
    Specified by:
    
    getLowerNonZeroHost in class IPAddress
    
    Returns:
    
    the lowest IP address series whose host is non-zero, or null if no such address section exists.
  - getLower
```
public IPv4Address getLower()
```
    Description copied from interface: AddressSegmentSeries
    
    If this represents a series with ranging values, returns a series representing the lower values of the range. If this represents an series with a single value in each segment, returns this.
    
    Specified by:
    
    getLower in interface AddressComponent
    
    Specified by:
    
    getLower in interface AddressSegmentSeries
    
    Specified by:
    
    getLower in interface IPAddressSegmentSeries
    
    Specified by:
    
    getLower in class IPAddress
    
    Returns:
  - getUpper
```
public IPv4Address getUpper()
```
    Description copied from interface: AddressSegmentSeries
    
    If this represents a series with ranging values, returns a series representing the upper values of the range If this represents a series with a single value in each segment, returns this.
    
    Specified by:
    
    getUpper in interface AddressComponent
    
    Specified by:
    
    getUpper in interface AddressSegmentSeries
    
    Specified by:
    
    getUpper in interface IPAddressSegmentSeries
    
    Specified by:
    
    getUpper in class IPAddress
    
    Returns:
  - intValue
```
public int intValue()
```
    Returns:
    
    the address (or lowest value of the address if a subnet) as a signed integer
  - upperIntValue
```
public int upperIntValue()
```
    Returns:
    
    the address (or highest value of the address if a subnet) as a signed integer
  - longValue
```
public long longValue()
```
    Returns:
    
    the address (or lowest value of the address if a subnet) as a positive integer
  - upperLongValue
```
public long upperLongValue()
```
    Returns:
    
    the address (or highest value of the address if a subnet) as a positive integer
  - replace
```
public IPv4Address replace(int startIndex,
                           int endIndex,
                           IPv4Address replacement,
                           int replacementIndex)
```
    Replaces segments starting from startIndex and ending before endIndex with the same number of segments starting at replacementStartIndex from the replacement section
    
    Parameters:
    
    startIndex -
    
    endIndex -
    
    replacement -
    
    replacementIndex -
    
    Returns:
    
    Throws:
    
    java.lang.IndexOutOfBoundsException
  - reverseBits
```
public IPv4Address reverseBits(boolean perByte)
```
    Description copied from interface: AddressSegmentSeries
    
    Returns a new segment series with the bits reversed.
    
    Specified by:
    
    reverseBits in interface AddressComponent
    
    Specified by:
    
    reverseBits in interface AddressSegmentSeries
    
    Specified by:
    
    reverseBits in interface IPAddressSegmentSeries
    
    Specified by:
    
    reverseBits in class IPAddress
    
    Parameters:
    
    perByte - if true, only the bits in each byte are reversed, if false, then all bits in the component are reversed
    
    Returns:
  - reverseBytes
```
public IPv4Address reverseBytes()
```
    Description copied from interface: AddressSegmentSeries
    
    Returns a new segment series with the bytes reversed.
    
    Specified by:
    
    reverseBytes in interface AddressComponent
    
    Specified by:
    
    reverseBytes in interface AddressSegmentSeries
    
    Specified by:
    
    reverseBytes in interface IPAddressSegmentSeries
    
    Specified by:
    
    reverseBytes in class IPAddress
    
    Returns:
  - reverseBytesPerSegment
```
public IPv4Address reverseBytesPerSegment()
```
    Description copied from interface: AddressSegmentSeries
    
    Returns a new segment series with the bytes reversed within each segment.
    
    Specified by:
    
    reverseBytesPerSegment in interface AddressSegmentSeries
    
    Specified by:
    
    reverseBytesPerSegment in interface IPAddressSegmentSeries
    
    Specified by:
    
    reverseBytesPerSegment in class IPAddress
    
    Returns:
  - reverseSegments
```
public IPv4Address reverseSegments()
```
    Description copied from interface: AddressSegmentSeries
    
    Returns a new segment series with the segments reversed. This does not throw IncompatibleAddressException since all address series can reverse their segments.
    
    Specified by:
    
    reverseSegments in interface AddressSegmentSeries
    
    Specified by:
    
    reverseSegments in interface IPAddressSegmentSeries
    
    Specified by:
    
    reverseSegments in class IPAddress
    
    Returns:
  - adjustPrefixBySegment
```
public IPv4Address adjustPrefixBySegment(boolean nextSegment)
```
    Description copied from interface: AddressSegmentSeries
    
    Increases or decreases prefix length to the next segment boundary.
    Follows the same rules as AddressSegmentSeries.adjustPrefixLength(int):
    When prefix length is increased, the bits moved within the prefix become zero. When a prefix length is decreased, the bits moved outside the prefix become zero.
    
    Specified by:
    
    adjustPrefixBySegment in interface AddressSegmentSeries
    
    Specified by:
    
    adjustPrefixBySegment in interface IPAddressSegmentSeries
    
    Specified by:
    
    adjustPrefixBySegment in class IPAddress
    
    Parameters:
    
    nextSegment - whether to move prefix to previous or following segment coundary
    
    Returns:
  - adjustPrefixBySegment
```
public IPv4Address adjustPrefixBySegment(boolean nextSegment,
                                         boolean zeroed)
```
    Description copied from interface: AddressSegmentSeries
    
    Increases or decreases prefix length to the next segment boundary.
    
    Specified by:
    
    adjustPrefixBySegment in interface AddressSegmentSeries
    
    Specified by:
    
    adjustPrefixBySegment in interface IPAddressSegmentSeries
    
    Specified by:
    
    adjustPrefixBySegment in class IPAddress
    
    Parameters:
    
    nextSegment - whether to move prefix to previous or following segment coundary
    
    zeroed - whether the bits that move from one side of the prefix to the other become zero or retain their original values
    
    Returns:
  - adjustPrefixLength
```
public IPv4Address adjustPrefixLength(int adjustment)
```
    Description copied from class: IPAddress
    
    Increases or decreases prefix length by the given increment.
    When prefix length is increased, the bits moved within the prefix become zero. When the prefix is extended beyond the segment series boundary, it is removed. When a prefix length is decreased, the bits moved outside the prefix become zero, and if the entire host address contains the zero address, then the resulting address is determined AddressNetwork.getPrefixConfiguration().
    For example, 1.2.0.0/16 adjusted by -8 becomes 1.0.0.0/8.
    1.2.0.0/16 adjusted by 8 becomes 1.2.0.0/24
    
    Specified by:
    
    adjustPrefixLength in interface AddressSegmentSeries
    
    Specified by:
    
    adjustPrefixLength in interface IPAddressSegmentSeries
    
    Specified by:
    
    adjustPrefixLength in class IPAddress
    
    Returns:
  - adjustPrefixLength
```
public IPv4Address adjustPrefixLength(int adjustment,
                                      boolean zeroed)
```
    Description copied from interface: AddressSegmentSeries
    
    Increases or decreases prefix length by the given increment.
    
    Specified by:
    
    adjustPrefixLength in interface AddressSegmentSeries
    
    Specified by:
    
    adjustPrefixLength in interface IPAddressSegmentSeries
    
    Specified by:
    
    adjustPrefixLength in class IPAddress
    
    Parameters:
    
    adjustment - the increment
    
    zeroed - whether the bits that move from one side of the prefix to the other become zero or retain their original values
    
    Returns:
  - setPrefixLength
```
public IPv4Address setPrefixLength(int prefixLength)
```
    Description copied from interface: AddressSegmentSeries
    
    Sets the prefix length.
    If this series has a prefix length, and the prefix length is increased, the bits moved within the prefix become zero.
    When the prefix is extended beyond the segment series boundary, it is removed.
    The bits that move from one side of the prefix length to the other (ie bits moved into the prefix or outside the prefix) are zeroed.
    
    Specified by:
    
    setPrefixLength in interface AddressSegmentSeries
    
    Specified by:
    
    setPrefixLength in interface IPAddressSegmentSeries
    
    Specified by:
    
    setPrefixLength in class IPAddress
    
    Returns:
    
    See Also:
    
    AddressSegmentSeries.applyPrefixLength(int)
  - setPrefixLength
```
public IPv4Address setPrefixLength(int prefixLength,
                                   boolean zeroed)
```
    Description copied from interface: AddressSegmentSeries
    
    Sets the prefix length.
    When the prefix is extended beyond the segment series boundary, it is removed.
    
    Specified by:
    
    setPrefixLength in interface AddressSegmentSeries
    
    Specified by:
    
    setPrefixLength in interface IPAddressSegmentSeries
    
    Specified by:
    
    setPrefixLength in class IPAddress
    
    zeroed - whether the bits that move from one side of the prefix length to the other (ie bits moved into the prefix or outside the prefix) are zeroed.
    
    Returns:
  - applyPrefixLength
```
public IPv4Address applyPrefixLength(int networkPrefixLength)
                              throws PrefixLenException
```
    Description copied from interface: AddressSegmentSeries
    
    Applies the given prefix length to create a new segment series.
    Similar to AddressSegmentSeries.setPrefixLength(int) except that prefix lengths are never increased. When this series already has a prefix length that is less than or equal to the requested prefix length, this series is returned.
    Otherwise the returned series has the given prefix length.
    The bits moved outside the prefix will become zero in the returned series.
    
    Specified by:
    
    applyPrefixLength in interface AddressSegmentSeries
    
    Specified by:
    
    applyPrefixLength in interface IPAddressSegmentSeries
    
    Specified by:
    
    applyPrefixLength in class IPAddress
    
    Returns:
    
    Throws:
    
    PrefixLenException
    
    See Also:
    
    AddressSegmentSeries.setPrefixLength(int)
  - removePrefixLength
```
public IPv4Address removePrefixLength(boolean zeroed)
```
    Description copied from interface: AddressSegmentSeries
    
    Removes the prefix length.
    
    Specified by:
    
    removePrefixLength in interface AddressSegmentSeries
    
    Specified by:
    
    removePrefixLength in interface IPAddressSegmentSeries
    
    Specified by:
    
    removePrefixLength in class IPAddress
    
    Parameters:
    
    zeroed - whether the bits outside the prefix become zero
    
    Returns:
  - removePrefixLength
```
public IPv4Address removePrefixLength()
```
    Description copied from interface: AddressSegmentSeries
    
    Removes the prefix length.
    If the series already has a prefix length, the bits outside the prefix become zero.
    
    Specified by:
    
    removePrefixLength in interface AddressSegmentSeries
    
    Specified by:
    
    removePrefixLength in interface IPAddressSegmentSeries
    
    Specified by:
    
    removePrefixLength in class IPAddress
    
    Returns:
    
    See Also:
    
    IPAddressSegmentSeries.removePrefixLength(boolean)
  - segmentsNonZeroHostIterator
```
public java.util.Iterator<IPv4AddressSegment[]> segmentsNonZeroHostIterator()
```
    Specified by:
    
    segmentsNonZeroHostIterator in interface IPAddressSegmentSeries
  - segmentsIterator
```
public java.util.Iterator<IPv4AddressSegment[]> segmentsIterator()
```
    Description copied from interface: AddressSegmentSeries
    
    Iterates through the individual segments.
    
    Specified by:
    
    segmentsIterator in interface AddressSegmentSeries
    
    Specified by:
    
    segmentsIterator in interface IPAddressSegmentSeries
  - iterator
```
public java.util.Iterator<IPv4Address> iterator()
```
    Description copied from interface: AddressSegmentSeries
    
    Iterates through the individual segment series. The resulting elements will not have an assigned prefix.
    
    Specified by:
    
    iterator in interface AddressComponent
    
    Specified by:
    
    iterator in interface AddressSegmentSeries
    
    Specified by:
    
    iterator in interface IPAddressSegmentSeries
    
    Specified by:
    
    iterator in interface java.lang.Iterable<IPv4Address>
    
    Specified by:
    
    iterator in class IPAddress
    
    Returns:
  - nonZeroHostIterator
```
public java.util.Iterator<IPv4Address> nonZeroHostIterator()
```
    Specified by:
    
    nonZeroHostIterator in interface IPAddressSegmentSeries
    
    Specified by:
    
    nonZeroHostIterator in class IPAddress
  - prefixBlockIterator
```
public java.util.Iterator<IPv4Address> prefixBlockIterator()
```
    Description copied from interface: AddressSegmentSeries
    
    Iterates through the individual prefix blocks. If the series has no prefix length, then this is equivalent to AddressSegmentSeries.iterator()
    
    Specified by:
    
    prefixBlockIterator in interface AddressSegmentSeries
    
    Specified by:
    
    prefixBlockIterator in interface IPAddressSegmentSeries
    
    Specified by:
    
    prefixBlockIterator in class IPAddress
  - getIterable
```
public java.lang.Iterable<IPv4Address> getIterable()
```
    Description copied from interface: AddressComponent
    
    Useful for using an instance in a "for-each loop". Otherwise just call AddressComponent.iterator() directly.
    
    Specified by:
    
    getIterable in interface AddressComponent
    
    Specified by:
    
    getIterable in interface AddressSegmentSeries
    
    Specified by:
    
    getIterable in interface IPAddressSegmentSeries
    
    Specified by:
    
    getIterable in class IPAddress
    
    Returns:
    
    an object to iterate over the individual addresses represented by this object.
  - increment
```
public IPv4Address increment(long increment)
```
    Description copied from interface: AddressSegmentSeries
    
    Returns the series from the subnet that is the given increment upwards into the subnet range, or if the given increment is negative the given increment downwards into the subnet range, or if this is just an individual series, it simply adds the increment to this. If the increment is 0, then this series is returned.
    If the subnet has multiple values and the increment exceeds the subnet size, then the amount by which is exceeds the size is added to the upper series of the range (the final iterator value) or is subtracted from the lower series of the range (the first iterator value) if negative.
    If the subnet is just a single address values, the series is simply incremented by the given value, positive or negative.
    If a subnet has multiple values, a positive increment value is equivalent to the same number of values from the iterator. For instance, a increment of 1 is value 1 from the iterator, an increment of 2 is the second value from the iterator, and so on. A negative increment is equivalent to the same number of values preceding the upper bound of the iterator. For instance, an increment of -1 is the last value from the iterator, and increment of -2 is the second last value, and so on.
    Therefore, to get the series just above the highest series of the subnet, use an increment of size:count > 1 ? count + 1 : 1 where count is the subnet size. To get the series just below the lowest series of the subnet, use an increment of size:-(count > 1 ? count + 1 : 1) where count is the subnet size.
    
    Specified by:
    
    increment in interface AddressSegmentSeries
    
    Specified by:
    
    increment in interface IPAddressSegmentSeries
    
    Specified by:
    
    increment in class IPAddress
    
    Returns:
  - getNetwork
```
public IPv4AddressNetwork getNetwork()
```
    Description copied from interface: AddressSegmentSeries
    
    Returns the network object for series of the same version (eg IPv4, IPv6 and MAC each have their own network object)
    
    Specified by:
    
    getNetwork in interface AddressSegmentSeries
    
    Specified by:
    
    getNetwork in interface IPAddressSegmentSeries
    
    Specified by:
    
    getNetwork in class IPAddress
    
    Returns:
  - getIPv6Network
```
public IPv6AddressNetwork getIPv6Network()
```
  - intersect
```
public IPv4Address intersect(IPAddress other)
                      throws AddressConversionException
```
    Description copied from class: IPAddress
    
    Produces the subnet whose addresses are found in both this and the given subnet argument.
    This is also known as the conjunction of the two sets of addresses.
    If the address is not the same version, the default conversion will be applied using IPAddress.toIPv4() or IPAddress.toIPv6(), and it that fails, AddressConversionException will be thrown.
    
    Specified by:
    
    intersect in class IPAddress
    
    Returns:
    
    the subnet containing the addresses found in both this and the given subnet
    
    Throws:
    
    AddressConversionException - if the address argument could not be converted to the same address version as this
  - subtract
```
public IPv4Address[] subtract(IPAddress other)
                       throws AddressConversionException
```
    Description copied from class: IPAddress
    
    Subtract the given subnet from this subnet, returning an array of subnets 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 subnet but not in the provided subnet. This is also known as the relative complement of the given argument in this subnet.
    If the address is not the same version, the default conversion will be applied using IPAddress.toIPv4() or IPAddress.toIPv6(), and it that fails, AddressConversionException will be thrown.
    
    Specified by:
    
    subtract in class IPAddress
    
    Returns:
    
    the difference
    
    Throws:
    
    AddressConversionException - if the address argument could not be converted to the same address version as this
  - toZeroHost
```
public IPv4Address toZeroHost()
```
    Description copied from interface: IPAddressSegmentSeries
    
    Returns the segment series with a host of zero. If the series has no prefix length, then it returns an all-zero series.
    The resultant series will have the same prefix length if AddressNetwork.getPrefixConfiguration() is not AddressNetwork.PrefixConfiguration.ALL_PREFIXED_ADDRESSES_ARE_SUBNETS, otherwise it will no longer have a prefix length.
    For instance, you can get the network address for a subnet as follows: String addrStr = "1.2.3.4/16"; IPAddress address = new IPAddressString(addrStr).getAddress(); IPAddress networkAddress = address.toZeroHost(); //1.2.0.0
    
    Specified by:
    
    toZeroHost in interface IPAddressSegmentSeries
    
    Specified by:
    
    toZeroHost in class IPAddress
    
    Returns:
  - toZeroHost
```
public IPv4Address toZeroHost(int prefixLength)
```
    Description copied from interface: IPAddressSegmentSeries
    
    Produces the series with host values of 0 for the given prefix length.
    If this series has the same prefix length, then the resulting series will too, otherwise the resulting series will have no prefix length.
    This is nearly equivalent to doing the mask (bitwise conjunction) of this address series with the network mask for the given prefix length, but without the possibility of IncompatibleAddressException that can occur when applying a mask to a range of values. Instead, in this case, if the resulting series has a range of values, then the resulting series range boundaries will have host values of 0, but not necessarily the intervening values.
    For instance, you can get the network address for a subnet of prefix length 16 as follows: String addrStr = "1.2.3.4"; IPAddress address = new IPAddressString(addrStr).getAddress(); IPAddress networkAddress = address.toZeroHost(16); //1.2.0.0
    
    Specified by:
    
    toZeroHost in interface IPAddressSegmentSeries
    
    Specified by:
    
    toZeroHost in class IPAddress
    
    Returns:
  - toMaxHost
```
public IPv4Address toMaxHost()
```
    Description copied from interface: IPAddressSegmentSeries
    
    Returns the segment series with a host of all ones. If the series has no prefix length, then it returns an all-ones series.
    The resultant series will have the same prefix length if AddressNetwork.getPrefixConfiguration() is not AddressNetwork.PrefixConfiguration.ALL_PREFIXED_ADDRESSES_ARE_SUBNETS, otherwise it will no longer have a prefix length.
    For instance, you can get the broadcast address for a subnet as follows: String addrStr = "1.2.3.4/16"; IPAddress address = new IPAddressString(addrStr).getAddress(); IPAddress broadcastAddress = address.toMaxHost(); //1.2.255.255
    
    Specified by:
    
    toMaxHost in interface IPAddressSegmentSeries
    
    Specified by:
    
    toMaxHost in class IPAddress
    
    Returns:
  - toMaxHost
```
public IPv4Address toMaxHost(int prefixLength)
```
    Description copied from interface: IPAddressSegmentSeries
    
    Produces the series with host values of all one bits for the given prefix length.
    If this series has the same prefix length, then the resulting series will too, otherwise the resulting series will have no prefix length.
    This is nearly equivalent to doing the bitwise or (bitwise disjunction) of this address series with the network mask for the given prefix length, but without the possibility of IncompatibleAddressException that can occur when applying a mask to a range of values. Instead, in this case, if the resulting series has a range of values, then the resulting series range boundaries will have host values of all ones, but not necessarily the intervening values.
    For instance, you can get the broadcast address for a subnet of prefix length 16 as follows: String addrStr = "1.2.3.4"; IPAddress address = new IPAddressString(addrStr).getAddress(); IPAddress broadcastAddress = address.toMaxHost(16); //1.2.255.255
    
    Specified by:
    
    toMaxHost in interface IPAddressSegmentSeries
    
    Specified by:
    
    toMaxHost in class IPAddress
    
    Returns:
  - mask
```
public IPv4Address mask(IPAddress mask,
                        boolean retainPrefix)
                 throws IncompatibleAddressException,
                        AddressConversionException
```
    Description copied from class: IPAddress
    
    Applies the given mask to all addresses represented by this IPAddress. The mask is applied to all individual addresses. Any existing prefix length is removed beforehand. If the retainPrefix argument is true, then the existing prefix length will be applied to the result.
    If the mask is a different version than this, then the default conversion is applied first using IPAddress.toIPv4() or IPAddress.toIPv6()
    If this represents multiple addresses, and applying the mask to all addresses creates a set of addresses that cannot be represented as a contiguous range within each segment, then IncompatibleAddressException is thrown.
    
    Specified by:
    
    mask in class IPAddress
    
    Returns:
    
    Throws:
    
    IncompatibleAddressException - if this is a range of addresses and applying the mask results in an address that cannot be represented as a contiguous range within each segment
    
    AddressConversionException - if the address argument could not be converted to the same address version as this
  - mask
```
public IPv4Address mask(IPAddress mask)
                 throws IncompatibleAddressException,
                        AddressConversionException
```
    Description copied from class: IPAddress
    
    Equivalent to calling IPAddress.mask(IPAddress, boolean) with the second argument as false.
    If the mask is a different version than this, then the default conversion is applied first using IPAddress.toIPv4() or IPAddress.toIPv6()
    
    Specified by:
    
    mask in class IPAddress
    
    Returns:
    
    Throws:
    
    IncompatibleAddressException - if this is a range of addresses and applying the mask results in an address that cannot be represented as a contiguous range within each segment
    
    AddressConversionException - if the address argument could not be converted to the same address version as this
  - maskNetwork
```
public IPv4Address maskNetwork(IPAddress mask,
                               int networkPrefixLength)
                        throws IncompatibleAddressException,
                               PrefixLenException,
                               AddressConversionException
```
    Description copied from class: IPAddress
    
    Applies the given mask to all addresses represented by this IPAddress while also applying the given prefix length at the same time.
    Any existing prefix length is removed as the mask and new prefix length is applied to all individual addresses.
    If the mask is a different version than this, then the default conversion is applied first using IPAddress.toIPv4() or IPAddress.toIPv6()
    If this represents multiple addresses, and applying the mask to all addresses creates a set of addresses that cannot be represented as a contiguous range within each segment, then IncompatibleAddressException is thrown.
    
    Specified by:
    
    maskNetwork in class IPAddress
    
    Throws:
    
    IncompatibleAddressException - if this is a range of addresses and applying the mask results in an address that cannot be represented as a contiguous range within each segment
    
    AddressConversionException - if the address argument could not be converted to the same address version as this
    
    PrefixLenException
  - bitwiseOr
```
public IPv4Address bitwiseOr(IPAddress mask,
                             boolean retainPrefix)
                      throws IncompatibleAddressException,
                             AddressConversionException
```
    Description copied from class: IPAddress
    
    Does the bitwise disjunction with this address. Useful when subnetting.
    The mask is applied to all individual addresses, similar to how the method IPAddress.mask(IPAddress, boolean) applies the bitwise conjunction. Any existing prefix length is removed beforehand. If the retainPrefix argument is true, then the existing prefix length will be applied to the result.
    If the mask is a different version than this, then the default conversion is applied first using IPAddress.toIPv4() or IPAddress.toIPv6()
    If you wish to mask a portion of the network, use IPAddress.bitwiseOrNetwork(IPAddress, int)
    For instance, you can get the broadcast address for a subnet as follows: String addrStr = "1.2.3.4/16"; IPAddress address = new IPAddressString(addrStr).getAddress(); IPAddress hostMask = address.getNetwork().getHostMask(address.getNetworkPrefixLength());//0.0.255.255 IPAddress broadcastAddress = address.bitwiseOr(hostMask); //1.2.255.255
    
    Specified by:
    
    bitwiseOr in class IPAddress
    
    Returns:
    
    Throws:
    
    IncompatibleAddressException - if this is a range of addresses and applying the mask results in an address that cannot be represented as a contiguous range within each segment
    
    AddressConversionException - if the address argument could not be converted to the same address version as this
  - bitwiseOr
```
public IPv4Address bitwiseOr(IPAddress mask)
                      throws IncompatibleAddressException,
                             AddressConversionException
```
    Description copied from class: IPAddress
    
    Equivalent to calling IPAddress.bitwiseOr(IPAddress, boolean) with the second argument as false.
    If the mask is a different version than this, then the default conversion is applied first using IPAddress.toIPv4() or IPAddress.toIPv6()
    
    Specified by:
    
    bitwiseOr in class IPAddress
    
    Returns:
    
    Throws:
    
    IncompatibleAddressException - if this is a range of addresses and applying the mask results in an address that cannot be represented as a contiguous range within each segment
    
    AddressConversionException - if the address argument could not be converted to the same address version as this
  - bitwiseOrNetwork
```
public IPv4Address bitwiseOrNetwork(IPAddress mask,
                                    int networkPrefixLength)
                             throws IncompatibleAddressException,
                                    PrefixLenException,
                                    AddressConversionException
```
    Description copied from class: IPAddress
    
    Does the bitwise disjunction with this address. Useful when subnetting.
    If the mask is a different version than this, then the default conversion is applied first using IPAddress.toIPv4() or IPAddress.toIPv6()
    Any existing prefix length is dropped for the new prefix length and the mask is applied up to the end the new prefix length. It is similar to how the IPAddress.maskNetwork(IPAddress, int) method does the bitwise conjunction.
    
    Specified by:
    
    bitwiseOrNetwork in class IPAddress
    
    networkPrefixLength - the new prefix length for the address
    
    Returns:
    
    Throws:
    
    IncompatibleAddressException - if this is a range of addresses and applying the mask results in an address that cannot be represented as a contiguous range within each segment
    
    AddressConversionException - if the address argument could not be converted to the same address version as this
    
    PrefixLenException
  - getNetworkSection
```
public IPv4AddressSection getNetworkSection()
```
    Description copied from interface: IPAddressSegmentSeries
    
    Returns the network section of the series if the series has a CIDR network prefix length, otherwise it returns the entire series as a prefixed series with prefix matching the address bit length.
    
    Specified by:
    
    getNetworkSection in interface IPAddressSegmentSeries
    
    Returns:
  - getNetworkSection
```
public IPv4AddressSection getNetworkSection(int networkPrefixLength)
                                     throws PrefixLenException
```
    Description copied from interface: IPAddressSegmentSeries
    
    Returns the network section of the series. The returned section will have only as many segments as needed as indicated by networkPrefixLength. 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 interface IPAddressSegmentSeries
    
    Returns:
    
    Throws:
    
    PrefixLenException
  - getNetworkSection
```
public IPv4AddressSection getNetworkSection(int networkPrefixLength,
                                            boolean withPrefixLength)
                                     throws PrefixLenException
```
    Description copied from interface: IPAddressSegmentSeries
    
    Returns the network section of the series. The returned section will have only as many segments as needed as indicated by networkPrefixLength. If withPrefixLength is true, it will have networkPrefixLength as its associated prefix length, unless this series already has a smaller prefix length, in which case the existing prefix length is retained.
    
    Specified by:
    
    getNetworkSection in interface IPAddressSegmentSeries
    
    withPrefixLength - whether the resulting section will have networkPrefixLength as the associated prefix length or not
    
    Returns:
    
    Throws:
    
    PrefixLenException
  - getHostSection
```
public IPv4AddressSection getHostSection()
```
    Description copied from interface: IPAddressSegmentSeries
    
    Returns the host section of the series. The returned section will have only as many segments as needed as determined by the existing CIDR network prefix length. If this series has no CIDR prefix length, the returned host section will be the full section associated with a prefix length of 0.
    
    Specified by:
    
    getHostSection in interface IPAddressSegmentSeries
    
    Returns:
  - getHostSection
```
public IPv4AddressSection getHostSection(int networkPrefixLength)
                                  throws PrefixLenException
```
    Description copied from interface: IPAddressSegmentSeries
    
    Returns the host section of the address as indicated by the network prefix length provided. The returned section will have only as many segments as needed to hold the host as indicated by the provided network prefix length.
    
    Specified by:
    
    getHostSection in interface IPAddressSegmentSeries
    
    Returns:
    
    Throws:
    
    PrefixLenException
  - toPrefixBlock
```
public IPv4Address toPrefixBlock()
```
    Description copied from class: IPAddress
    
    Returns the subnet associated with the prefix length of this address. If this address has no prefix length, this address is returned.
    For example, if the address is 1.2.3.4/16 it returns the subnet 1.2.*.* /16
    
    Specified by:
    
    toPrefixBlock in interface AddressSegmentSeries
    
    Specified by:
    
    toPrefixBlock in interface IPAddressSegmentSeries
    
    Specified by:
    
    toPrefixBlock in class IPAddress
    
    Returns:
    
    the block of address series for the prefix length
  - toPrefixBlock
```
public IPv4Address toPrefixBlock(int networkPrefixLength)
                          throws PrefixLenException
```
    Description copied from interface: IPAddressSegmentSeries
    
    Returns the segment series of the same length that spans all hosts. The network prefix length will be the one provided, and the network values will match the same of this series.
    
    Specified by:
    
    toPrefixBlock in interface IPAddressSegmentSeries
    
    Specified by:
    
    toPrefixBlock in class IPAddress
    
    Returns:
    
    Throws:
    
    PrefixLenException
  - assignPrefixForSingleBlock
```
public IPv4Address assignPrefixForSingleBlock()
```
    Description copied from class: IPAddress
    
    Returns the equivalent CIDR address with a prefix length for which the address subnet block matches the range of values in this address.
    If no such prefix length exists, returns null.
    Examples:
    1.2.3.4 returns 1.2.3.4/32
    1.2.*.* returns 1.2.0.0/16
    1.2.*.0/24 returns 1.2.0.0/16
    1.2.*.4 returns null
    1.2.252-255.* returns 1.2.252.0/22
    1.2.3.4/x returns the same address
    
    Specified by:
    
    assignPrefixForSingleBlock in interface IPAddressSegmentSeries
    
    Overrides:
    
    assignPrefixForSingleBlock in class IPAddress
    
    Returns:
    
    See Also:
    
    IPAddressSegmentSeries.toPrefixBlock(), IPAddressSegmentSeries.assignMinPrefixForBlock()
  - assignMinPrefixForBlock
```
public IPv4Address assignMinPrefixForBlock()
```
    Description copied from class: IPAddress
    
    Constructs an equivalent address with the smallest CIDR prefix possible (largest network), such that the range of values are a set of subnet blocks for that prefix.
    
    Specified by:
    
    assignMinPrefixForBlock in interface IPAddressSegmentSeries
    
    Overrides:
    
    assignMinPrefixForBlock in class IPAddress
    
    Returns:
    
    See Also:
    
    IPAddressSegmentSeries.toPrefixBlock(), IPAddressSegmentSeries.assignPrefixForSingleBlock()
  - spanWithPrefixBlocks
```
public IPv4Address[] spanWithPrefixBlocks(IPAddress other)
                                   throws AddressConversionException
```
    Description copied from class: IPAddress
    
    Produces the list of prefix block subnets that span from this series to the given series.
    If the other address is a different version than this, then the default conversion is applied first using IPAddress.toIPv4() or IPAddress.toIPv6()
    The resulting array is sorted from lowest address value to highest, regardless of the size of each prefix block.
    
    Specified by:
    
    spanWithPrefixBlocks in class IPAddress
    
    Returns:
    
    Throws:
    
    AddressConversionException
  - mergePrefixBlocks
```
public IPv4Address[] mergePrefixBlocks(IPAddress... addresses)
                                throws AddressConversionException
```
    Description copied from class: IPAddress
    
    Merges this with the list of addresses to produce the smallest list of prefix blocks
    If any other address in the list is a different version than this, then the default conversion is applied first using IPAddress.toIPv4() or IPAddress.toIPv6(), which can result in AddressConversionException
    The result is sorted from single address to smallest blocks to largest blocks.
    
    Specified by:
    
    mergePrefixBlocks in class IPAddress
    
    Parameters:
    
    addresses - the addresses to merge with this
    
    Returns:
    
    Throws:
    
    AddressConversionException
  - toUpperInetAddress
```
public java.net.Inet4Address toUpperInetAddress()
```
    Description copied from class: IPAddress
    
    Converts the highest value of this address to an InetAddress. If this consists of just a single address and not a subnet, this is equivalent to IPAddress.toInetAddress()
    
    Overrides:
    
    toUpperInetAddress in class IPAddress
  - toInetAddress
```
public java.net.Inet4Address toInetAddress()
```
    Description copied from class: IPAddress
    
    Converts the lowest value of this address to an InetAddress
    
    Overrides:
    
    toInetAddress in class IPAddress
  - isLocal
```
public boolean isLocal()
```
    Description copied from class: IPAddress
    
    Returns true if the address is link local, site local, organization local, administered locally, or unspecified. This includes both unicast and multicast.
    
    Specified by:
    
    isLocal in class IPAddress
    
    Returns:
  - isLinkLocal
```
public boolean isLinkLocal()
```
    Description copied from class: IPAddress
    
    Returns whether the address is link local, whether unicast or multicast.
    
    Specified by:
    
    isLinkLocal in class IPAddress
    
    See Also:
    
    InetAddress.isLinkLocalAddress()
  - isPrivate
```
public boolean isPrivate()
```
    Unicast addresses allocated for private use
    
    See Also:
    
    InetAddress.isSiteLocalAddress()
  - isMulticast
```
public boolean isMulticast()
```
    Description copied from class: Address
    
    Whether the MAC address or IP address or other form of address is multicast.
    
    Specified by:
    
    isMulticast in class Address
    
    See Also:
    
    InetAddress.isMulticastAddress()
  - isLoopback
```
public boolean isLoopback()
```
    Specified by:
    
    isLoopback in class IPAddress
    
    See Also:
    
    InetAddress.isLoopbackAddress()
  - toNormalizedString
```
public static java.lang.String toNormalizedString(IPv4AddressNetwork network,
                                                  Address.SegmentValueProvider lowerValueProvider,
                                                  Address.SegmentValueProvider upperValueProvider,
                                                  java.lang.Integer prefixLength)
```
    Creates the normalized string for an address without having to create the address objects first.
    
    Parameters:
    
    lowerValueProvider -
    
    upperValueProvider -
    
    prefixLength -
    
    Returns:
  - 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:
  - 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)
```
    Specified by:
    
    toStringCollection in interface IPAddressSegmentSeries
    
    Overrides:
    
    toStringCollection in class IPAddress
  - toStringCollection
```
public IPAddressPartStringCollection toStringCollection(IPv4AddressSection.IPv4StringBuilderOptions opts)
```

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

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

Fields inherited from class inet.ipaddr.IPAddress

Fields inherited from class inet.ipaddr.Address

Methods inherited from class inet.ipaddr.IPAddress

Methods inherited from class inet.ipaddr.Address

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Methods inherited from interface inet.ipaddr.AddressSegmentSeries

Methods inherited from interface inet.ipaddr.format.AddressDivisionSeries

Methods inherited from interface inet.ipaddr.format.AddressStringDivisionSeries

Methods inherited from interface inet.ipaddr.AddressComponent

Methods inherited from interface inet.ipaddr.format.AddressItem

SEGMENT_SEPARATOR

BITS_PER_SEGMENT

BYTES_PER_SEGMENT

SEGMENT_COUNT

BYTE_COUNT

BIT_COUNT

DEFAULT_TEXTUAL_RADIX

MAX_VALUE_PER_SEGMENT

REVERSE_DNS_SUFFIX

IPv4Address

IPv4Address

IPv4Address

IPv4Address

IPv4Address

IPv4Address

IPv4Address

IPv4Address

IPv4Address

IPv4Address

IPv4Address

IPv4Address

IPv4Address

IPv4Address

getSection

getSection

getSection

getDivision

getSegment

getSegments

getParts

getParts

getSegmentCount

getByteCount

getBitCount

toIPv4

isIPv4Convertible

getIPv6Address

getIPv4MappedAddress

isIPv6Convertible

toIPv6

toBroadcastAddress

toNetworkAddress

getLowerNonZeroHost

getLower

getUpper

intValue

upperIntValue

longValue

upperLongValue

replace

reverseBits

reverseBytes

reverseBytesPerSegment

reverseSegments

adjustPrefixBySegment

adjustPrefixBySegment

adjustPrefixLength

adjustPrefixLength

setPrefixLength

setPrefixLength

applyPrefixLength

removePrefixLength

removePrefixLength

segmentsNonZeroHostIterator

segmentsIterator

iterator

nonZeroHostIterator