public class IPv6Address extends IPAddress implements Iterable<IPv6Address>
You can construct an IPv6 address from a byte array, from a BigInteger, from a Address.SegmentValueProvider,
from Inet6Address, from MACAddress, from an IPv6AddressSection of 8 segments, or from an array of 8 IPv6AddressSegment objects.
To construct one from a String use
IPAddressString.toAddress() or IPAddressString.getAddress(), IPAddressString.toHostAddress() or IPAddressString.getHostAddress()
An IPv6 address can have an associated zone, typically either a network interface name or a positive integer. An IPv6 zone distinguishes two IPv6 addresses that are the same.
A zone that consists of a scope id is called a scoped zone.
| Modifier and Type | Class and Description |
|---|---|
static interface |
IPv6Address.IPv6AddressConverter |
static class |
IPv6Address.IPv6Zone
A reference to a scope id by number or a network interface by name.
|
IPAddress.DualIPv4Pv6Arrays, IPAddress.IPAddressValueProvider, IPAddress.IPVersionAddress.AddressValueProvider, Address.SegmentValueProvider| Modifier and Type | Field and Description |
|---|---|
static char |
ALTERNATIVE_ZONE_SEPARATOR |
static int |
BASE_85_RADIX |
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 int |
MIXED_ORIGINAL_SEGMENT_COUNT |
static int |
MIXED_REPLACED_SEGMENT_COUNT |
static String |
REVERSE_DNS_SUFFIX |
static String |
REVERSE_DNS_SUFFIX_DEPRECATED |
static int |
SEGMENT_COUNT |
static char |
SEGMENT_SEPARATOR |
static char |
UNC_RANGE_SEPARATOR |
static String |
UNC_RANGE_SEPARATOR_STR |
static char |
UNC_SEGMENT_SEPARATOR |
static String |
UNC_SUFFIX |
static char |
UNC_ZONE_SEPARATOR |
static char |
ZONE_SEPARATOR |
BINARY_STR_PREFIX, DEFAULT_ADDRESS_CONVERTER, PREFIX_LEN_SEPARATORADDRESS_HIGH_VALUE_COMPARATOR, ADDRESS_LOW_VALUE_COMPARATOR, 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 and Description |
|---|
IPv6Address(Address.SegmentValueProvider valueProvider)
Constructs an IPv6 address.
|
IPv6Address(Address.SegmentValueProvider lowerValueProvider,
Address.SegmentValueProvider upperValueProvider)
Constructs an IPv6 address or subnet.
|
IPv6Address(Address.SegmentValueProvider lowerValueProvider,
Address.SegmentValueProvider upperValueProvider,
CharSequence zone)
|
IPv6Address(Address.SegmentValueProvider lowerValueProvider,
Address.SegmentValueProvider upperValueProvider,
Integer networkPrefixLength)
Constructs an IPv6 address or subnet.
|
IPv6Address(Address.SegmentValueProvider lowerValueProvider,
Address.SegmentValueProvider upperValueProvider,
IPv6Address.IPv6Zone zone)
Constructs an IPv6 address.
|
IPv6Address(Address.SegmentValueProvider valueProvider,
Integer networkPrefixLength)
Constructs an IPv6 address.
|
IPv6Address(BigInteger val)
Constructs an IPv6 address.
|
IPv6Address(BigInteger val,
CharSequence zone)
Deprecated.
|
IPv6Address(BigInteger val,
Integer networkPrefixLength)
Constructs an IPv6 address.
|
IPv6Address(BigInteger val,
Integer networkPrefixLength,
CharSequence zone)
Deprecated.
|
IPv6Address(BigInteger val,
Integer networkPrefixLength,
IPv6Address.IPv6Zone zone)
Constructs an IPv6 address or subnet.
|
IPv6Address(BigInteger val,
IPv6Address.IPv6Zone zone)
Constructs an IPv6 address.
|
IPv6Address(byte[] bytes)
Constructs an IPv6 address.
|
IPv6Address(byte[] bytes,
CharSequence zone)
Deprecated.
|
IPv6Address(byte[] bytes,
Integer networkPrefixLength)
Constructs an IPv6 address or subnet.
|
IPv6Address(byte[] bytes,
int byteStartIndex,
int byteEndIndex)
Constructs an IPv6 address or subnet.
|
IPv6Address(byte[] bytes,
int byteStartIndex,
int byteEndIndex,
Integer networkPrefixLength)
Constructs an IPv6 address or subnet.
|
IPv6Address(byte[] bytes,
IPv6Address.IPv6Zone zone)
Constructs an IPv6 address.
|
IPv6Address(Inet6Address inet6Address)
Constructs an IPv6 address.
|
IPv6Address(Inet6Address inet6Address,
Integer networkPrefixLength)
Constructs an IPv6 address.
|
IPv6Address(IPv6Address prefix,
MACAddress eui)
Constructs an IPv6 address from a modified EUI-64 (Extended Unique Identifier) address section and an IPv6 address section network prefix.
|
IPv6Address(IPv6AddressSection section) |
IPv6Address(IPv6AddressSection section,
CharSequence zone)
Deprecated.
|
IPv6Address(IPv6AddressSection section,
IPv6Address.IPv6Zone zone)
Constructs an IPv6 address or subnet.
|
IPv6Address(IPv6AddressSection section,
MACAddress eui)
Constructs an IPv6 address from a modified EUI-64 (Extended Unique Identifier) address section and an IPv6 address section network prefix.
|
IPv6Address(IPv6AddressSection section,
MACAddressSection eui)
Constructs an IPv6 address from a modified EUI-64 (Extended Unique Identifier) address and an IPv6 address section network prefix.
|
IPv6Address(IPv6AddressSection section,
MACAddressSection eui,
CharSequence zone)
Deprecated.
|
IPv6Address(IPv6AddressSection section,
MACAddressSection eui,
IPv6Address.IPv6Zone zone)
Constructs an IPv6 address from a modified EUI-64 (Extended Unique Identifier) address and an IPv6 address section network prefix.
|
IPv6Address(IPv6AddressSegment[] segments)
Constructs an IPv6 address or subnet.
|
IPv6Address(IPv6AddressSegment[] segments,
CharSequence zone)
Deprecated.
|
IPv6Address(IPv6AddressSegment[] segments,
Integer networkPrefixLength)
Constructs an IPv6 address or a set of addresses.
|
IPv6Address(IPv6AddressSegment[] segments,
IPv6Address.IPv6Zone zone)
Constructs an IPv6 address or a set of addresses.
|
IPv6Address(long highBytes,
long lowBytes)
Constructs an IPv6 address.
|
IPv6Address(long highBytes,
long lowBytes,
Integer networkPrefixLength)
Constructs an IPv6 address or subnet.
|
IPv6Address(long highBytes,
long lowBytes,
IPv6Address.IPv6Zone zone)
Constructs an IPv6 address.
|
| Modifier and Type | Method and Description |
|---|---|
IPv6Address |
adjustPrefixBySegment(boolean nextSegment)
Increases or decreases prefix length to the next segment boundary.
|
IPv6Address |
adjustPrefixBySegment(boolean nextSegment,
boolean zeroed)
Increases or decreases prefix length to the next segment boundary.
|
IPv6Address |
adjustPrefixLength(int adjustment)
Increases or decreases prefix length by the given increment.
|
IPv6Address |
adjustPrefixLength(int adjustment,
boolean zeroed)
Increases or decreases prefix length by the given increment.
|
IPv6Address |
applyPrefixLength(int networkPrefixLength)
Deprecated.
|
IPv6Address |
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.
|
IPv6Address |
assignPrefixForSingleBlock()
Returns the equivalent CIDR address with a prefix length for which the address subnet block matches the range of values in this address.
|
IPv6Address |
bitwiseOr(IPAddress mask)
Equivalent to calling
IPAddress.bitwiseOr(IPAddress, boolean) with the second argument as false. |
IPv6Address |
bitwiseOr(IPAddress mask,
boolean retainPrefix)
Does the bitwise disjunction with this address.
|
IPv6Address |
bitwiseOrNetwork(IPAddress mask,
int networkPrefixLength)
Does the bitwise disjunction with this address.
|
Iterator<IPv6Address> |
blockIterator(int segmentCount)
Iterates through series that can be obtained by iterating through all the upper segments up to the given segment count.
|
AddressComponentSpliterator<IPv6Address> |
blockSpliterator(int segmentCount)
Partitions and traverses through the individual sequential blocks created from each of the individual values up to the given segment count.
|
Stream<IPv6Address> |
blockStream(int segmentCount)
Returns a sequential stream of the individual blocks created from each of the individual values up to the given segment count.
|
boolean |
contains(Address other)
Returns whether this is same type and version of the given address and whether it contains all individual addresses in the given address or subnet
|
IPv6Address |
coverWithPrefixBlock()
Returns the minimal-size prefix block that covers all the values in this series.
|
IPv6Address |
coverWithPrefixBlock(IPAddress other)
Returns the minimal-size prefix block that covers all the addresses spanning from this subnet to the given subnet.
|
BigInteger |
enumerate(Address other)
Indicates where an address sits relative to the subnet ordering.
|
BigInteger |
enumerate(IPAddress other)
Indicates where an address sits relative to the subnet ordering.
|
IPv4Address |
get6To4IPv4Address()
Returns the second and third segments as an
IPv4Address. |
int |
getBitCount()
Provides the number of bits comprising this address item
|
int |
getByteCount()
Provides the number of bytes required for this address item, rounding up if the bit count is not a multiple of 8
|
IPv6AddressSegment |
getDivision(int index) |
IPv4Address |
getEmbeddedIPv4Address()
Returns the embedded
IPv4Address in the lowest (least-significant) two segments. |
IPv4Address |
getEmbeddedIPv4Address(int byteIndex)
Produces an IPv4 address from any sequence of 4 bytes in this IPv6 address.
|
IPv6Address |
getHostMask()
Returns the host mask associated with the CIDR network prefix length of this series.
|
IPv6AddressSection |
getHostSection()
Returns the host section of the series.
|
IPv6AddressSection |
getHostSection(int networkPrefixLength)
Returns the host section of the address as indicated by the network prefix length provided.
|
IPv4AddressNetwork |
getIPv4Network() |
IPv6Address.IPv6Zone |
getIPv6Zone()
Returns the zone or scope id, consisting of a network interface name or a positive integer scope identifier.
|
Iterable<IPv6Address> |
getIterable()
Useful for using an instance in a "for-each loop".
|
IPv6Address |
getLower()
If this represents a series with ranging values, returns a series representing the lower values of the range.
|
IPv6Address |
getLowerNonZeroHost()
Similar to
IPAddressSegmentSeries.getLower(), but will not return a series that has a prefix length and whose host value is zero. |
MACAddressNetwork |
getMACNetwork() |
IPv6AddressNetwork |
getNetwork()
Returns the network object for components of the same version (eg IPv4, IPv6 and MAC each have their own network object)
|
IPv6Address |
getNetworkMask()
Returns the network mask associated with the CIDR network prefix length of this series.
|
IPv6AddressSection |
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.
|
IPv6AddressSection |
getNetworkSection(int networkPrefixLength)
Returns the network section of the series.
|
IPv6AddressSection |
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(IPv6AddressSection.IPv6StringBuilderOptions options) |
IPv6AddressSection |
getSection()
Returns the address as an address section comprising all segments in the address.
|
IPv6AddressSection |
getSection(int index)
Gets the subsection from the series starting from the given index
The first segment is at index 0.
|
IPv6AddressSection |
getSection(int index,
int endIndex)
Gets the subsection from the series starting from the given index and ending just before the give endIndex
The first segment is at index 0.
|
IPv6AddressSegment |
getSegment(int index)
Returns the segment from this series at the given index.
|
int |
getSegmentCount()
Returns the number of segments in this series.
|
IPv6AddressSegment[] |
getSegments()
Returns the segments of this series of segments as an array.
|
IPv6Address |
getUpper()
If this represents a series with ranging values, returns a series representing the upper values of the range.
|
String |
getZone()
The zone or scope id string, which as a string is typically appended to an address with a '%', eg fe80::71a3:2b00:ddd3:753f%16
If there is no zone or scope id, returns null.
|
int |
hashCode() |
boolean |
hasZone()
Returns whether
getZone() returns a non-null value |
IPv6Address |
increment(BigInteger increment) |
IPv6Address |
increment(long increment)
Returns the series from the subnet that is the given increment upwards into the subnet range, with the increment of 0
returning the first address in the range.
|
IPv6Address |
incrementBoundary(long increment)
If the given increment is positive, adds the value to the upper series (
AddressSegmentSeries.getUpper()) in the subnet range to produce a new series. |
IPv6Address |
intersect(IPAddress other)
Produces the subnet whose addresses are found in both this and the given subnet argument, or null if no such addresses.
|
boolean |
is6Over4()
Whether the address is 6over4
|
boolean |
is6To4()
Whether the address is IPv6 to IPv4 relay
|
boolean |
isEUI64() |
boolean |
isIPv4Compatible()
Whether the address is IPv4-compatible
|
boolean |
isIPv4Convertible()
Determines whether this address can be converted to IPv4.
|
boolean |
isIPv4Mapped()
Whether the address is IPv4-mapped
::ffff:x:x/96 indicates IPv6 address mapped to IPv4
|
boolean |
isIPv4Translatable() |
boolean |
isIPv6() |
boolean |
isIPv6Convertible()
Determines whether an address can be converted to IPv6, if not IPv6 already.
|
boolean |
isIsatap()
Whether the address is ISATAP
|
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 |
isSameAddress(Address other) |
boolean |
isSiteLocal() |
boolean |
isTeredo()
Whether the address is Teredo
|
boolean |
isUniqueLocal() |
boolean |
isWellKnownIPv4Translatable()
Whether the address has the well-known prefix for IPv4 translatable addresses as in rfc 6052 and 6144
|
Iterator<IPv6Address> |
iterator()
Iterates through the individual address components.
|
long[] |
longValues()
Returns a pair of longs with the lower address value in the range of this individual address or subnet.
|
IPv6Address |
mask(IPAddress mask)
Equivalent to calling
IPAddress.mask(IPAddress, boolean) with the second argument as false. |
IPv6Address |
mask(IPAddress mask,
boolean retainPrefix)
Applies the given mask to all addresses represented by this IPAddress.
|
IPv6Address |
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.
|
IPv6Address[] |
mergeToPrefixBlocks(IPAddress... addresses)
Merges this with the list of addresses to produce the smallest list of prefix blocks.
|
IPv6Address[] |
mergeToSequentialBlocks(IPAddress... addresses)
Merges this with the list of subnets to produce the smallest list of block subnets that are sequential.
|
Iterator<IPv6Address> |
nonZeroHostIterator()
Similar to the iterator, but series with a host of zero are skipped.
|
boolean |
overlaps(Address other)
Returns whether this is same type and version of the given address and whether it overlaps with the individual addresses in the given address or subnet,
containing at least one individual address common to both.
|
Iterator<IPv6Address> |
prefixBlockIterator()
Iterates through the individual prefix blocks.
|
Iterator<IPv6Address> |
prefixBlockIterator(int prefixLength)
Iterates through the range of prefix blocks in this range instance using the given prefix length.
|
AddressComponentSpliterator<IPv6Address> |
prefixBlockSpliterator()
Partitions and traverses through the individual prefix blocks for the prefix length of this series.
|
AddressComponentSpliterator<IPv6Address> |
prefixBlockSpliterator(int prefixLength)
Partitions and traverses through the individual prefix blocks for the given prefix length.
|
Stream<IPv6Address> |
prefixBlockStream()
Returns a sequential stream of the individual prefix blocks for the prefix length of this series.
|
Stream<IPv6Address> |
prefixBlockStream(int prefixLength)
Returns a sequential stream of the prefix blocks for the given prefix length.
|
Iterator<IPv6Address> |
prefixIterator()
Iterates through the individual prefixes.
|
Iterator<IPv6Address> |
prefixIterator(int prefixLength)
Iterates through the range of prefixes in this range instance using the given prefix length.
|
AddressComponentSpliterator<IPv6Address> |
prefixSpliterator()
Partitions and traverses through the individual prefixes for the prefix length of this series.
|
AddressComponentSpliterator<IPv6Address> |
prefixSpliterator(int prefixLength)
Partitions and traverses through the individual prefixes for the given prefix length.
|
Stream<IPv6Address> |
prefixStream()
Returns a sequential stream of the individual prefixes for the prefix length of this series.
|
Stream<IPv6Address> |
prefixStream(int prefixLength)
Returns a sequential stream of the individual prefixes for the given prefix length.
|
IPv6Address |
removePrefixLength()
Deprecated.
|
IPv6Address |
removePrefixLength(boolean zeroed)
Deprecated.
|
IPv6Address |
removeZone()
Returns the equivalent address but with no zone.
|
IPv6Address |
replace(int startIndex,
int endIndex,
IPv6Address 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
|
IPv6Address |
replace(int startIndex,
IPv6AddressSection replacement)
Replaces segments starting from startIndex with as many segments as possible from the replacement section
|
IPv6Address |
reverseBits(boolean perByte)
Returns a new segment series with the bits reversed.
|
IPv6Address |
reverseBytes()
Returns a new segment series with the bytes reversed.
|
IPv6Address |
reverseBytesPerSegment()
Returns a new segment series with the bytes reversed within each segment.
|
IPv6Address |
reverseSegments()
Returns a new segment series with the segments reversed.
|
Iterator<IPv6AddressSegment[]> |
segmentsIterator()
Iterates through the individual segments.
|
Iterator<IPv6AddressSegment[]> |
segmentsNonZeroHostIterator()
Similar to the segments iterator, but series with a host of zero are skipped.
|
AddressComponentRangeSpliterator<IPv6Address,IPv6AddressSegment[]> |
segmentsSpliterator()
Partitions and traverses through the individual segment arrays.
|
Stream<IPv6AddressSegment[]> |
segmentsStream()
Returns a sequential stream of the individual segment arrays.
|
Iterator<IPv6Address> |
sequentialBlockIterator()
Iterates through the sequential series that make up this series.
|
AddressComponentSpliterator<IPv6Address> |
sequentialBlockSpliterator()
Partitions and traverses through the individual sequential blocks.
|
Stream<IPv6Address> |
sequentialBlockStream()
Returns a sequential stream of the individual sequential blocks.
|
IPv6Address |
setPrefixLength(int prefixLength)
Sets the prefix length.
|
IPv6Address |
setPrefixLength(int prefixLength,
boolean zeroed)
Sets the prefix length.
|
IPv6Address |
setPrefixLength(int prefixLength,
boolean zeroed,
boolean zeroHostIsBlock)
Sets the prefix length while allowing the caller to control whether bits moved in or out of the prefix become zero,
and whether a zero host for the new prefix bits can be translated into a prefix block.
|
IPv6Address |
setZone(IPv6Address.IPv6Zone newZone)
Returns a new address with the same address values but with the supplied zone.
|
IPv6Address[] |
spanWithPrefixBlocks()
Produces an array of prefix blocks that cover the same set of addresses as this.
|
IPv6Address[] |
spanWithPrefixBlocks(IPAddress other)
Produces the list of prefix block subnets that span from this subnet to the given subnet.
|
IPv6AddressSeqRange |
spanWithRange(IPAddress other)
Produces an IPAddressRange instance that spans this subnet to the given subnet.
|
IPv6Address[] |
spanWithSequentialBlocks()
Produces an array of blocks that are sequential that cover the same set of addresses as this.
|
IPv6Address[] |
spanWithSequentialBlocks(IPAddress other)
Produces a list of sequential block subnets that span all values from this subnet to the given subnet.
|
AddressComponentSpliterator<IPv6Address> |
spliterator()
Partitions and traverses through the individual address components.
|
Stream<IPv6Address> |
stream()
Returns a sequential stream of the individual address components.
|
IPv6Address[] |
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() |
String |
toBase85String()
The base 85 string is described by RFC 1924
|
String |
toBinaryString()
Writes this address as a single binary value with always the exact same number of characters
|
String |
toCanonicalString()
This produces a canonical string.
|
String |
toCanonicalWildcardString()
This produces a string similar to the canonical string but avoids the CIDR prefix.
|
String |
toCompressedString()
This compresses the maximum number of zeros and/or host segments with the IPv6 compression notation '::'
|
String |
toCompressedWildcardString()
This is similar to toNormalizedWildcardString, avoiding the CIDR prefix, but with compression as well.
|
String |
toConvertedString()
Returns a mixed string if it represents a convertible IPv4 address, returns the normalized string otherwise.
|
MACAddress |
toEUI(boolean extended) |
String |
toFullString()
This produces a string with no compressed segments and all segments of full length,
which is 4 characters for IPv6 segments and 3 characters for IPv4 segments.
|
String |
toHexString(boolean with0xPrefix)
Writes this address as a single hexadecimal value with always the exact same number of characters, with or without a preceding 0x prefix.
|
Inet6Address |
toInetAddress()
Converts the lowest value of this address and the associated zone to an Inet6Address.
|
IPv4Address |
toIPv4()
If this address is IPv4 convertible, returns that address.
|
IPv6Address |
toIPv6() |
IPv4AddressSection |
toMappedIPv4Segments()
::ffff:x:x/96 indicates IPv6 address mapped to IPv4
|
IPv6Address |
toMaxHost()
Returns the segment series with a host of all ones.
|
IPv6Address |
toMaxHost(int prefixLength)
Produces the series with host values of all one bits for the given prefix length.
|
String |
toMixedString()
Produces a string in which the lower 4 bytes are expressed as an IPv4 address and the remaining upper bytes are expressed in IPv6 format.
|
String |
toNormalizedString()
The normalized string returned by this method is consistent with java.net.Inet6address.
|
String |
toNormalizedString(boolean keepMixed,
IPv6AddressSection.IPv6StringOptions params)
Constructs a string representing this address according to the given parameters
|
String |
toNormalizedString(IPAddressSection.IPStringOptions params)
Constructs a string representing this address according to the given parameters
|
static String |
toNormalizedString(IPv6AddressNetwork network,
Address.SegmentValueProvider lowerValueProvider,
Address.SegmentValueProvider upperValueProvider,
Integer prefixLength,
CharSequence zone)
Creates the normalized string for an address without having to create the address objects first.
|
String |
toNormalizedString(IPv6AddressSection.IPv6StringOptions params) |
String |
toNormalizedWildcardString()
This produces a string similar to the normalized string but avoids the CIDR prefix.
|
String |
toOctalString(boolean with0Prefix)
Writes this address as a single octal value with always the exact same number of characters, with or without a preceding 0 prefix.
|
IPv6Address |
toPrefixBlock()
Returns the subnet associated with the prefix length of this address.
|
IPv6Address |
toPrefixBlock(int networkPrefixLength)
Returns the segment series of the same length that spans all hosts.
|
String |
toPrefixLengthString()
Returns a string with a CIDR network prefix length if this address has a network prefix length.
|
String |
toSegmentedBinaryString()
Writes this IP address segment series as a segments of binary values preceded by the "0b" prefix.
|
IPv6AddressSeqRange |
toSequentialRange()
Creates a sequential range instance from the lowest and highest addresses in this subnet
|
IPv6AddressSeqRange |
toSequentialRange(IPAddress other)
Deprecated.
|
String |
toSQLWildcardString()
This is the same as the string from toNormalizedWildcardString except that
it uses
Address.SEGMENT_SQL_WILDCARD instead of Address.SEGMENT_WILDCARD and also uses Address.SEGMENT_SQL_SINGLE_WILDCARD |
IPAddressPartStringCollection |
toStandardStringCollection() |
IPAddressPartStringCollection |
toStringCollection(IPAddressSection.IPStringBuilderOptions opts) |
IPAddressPartStringCollection |
toStringCollection(IPv6AddressSection.IPv6StringBuilderOptions opts) |
String |
toSubnetString()
Produces a consistent subnet string that looks like 1.2.*.* or 1:2::/16
In the case of IPv4, this means that wildcards are used instead of a network prefix when a network prefix has been supplied.
|
String |
toUNCHostName()
Generates the Microsoft UNC path component for this address
|
Inet6Address |
toUpperInetAddress()
Converts the highest value of this address to an InetAddress.
|
IPv6Address |
toZeroHost()
Returns the segment series with a host of zero, the host being the bits following the prefix length.
|
IPv6Address |
toZeroHost(int prefixLength)
Produces the series with host values of 0 for the given prefix length.
|
IPv6Address |
toZeroNetwork()
Returns the segment series with a network of zero, the network being the bits within the prefix length.
|
long[] |
upperLongValues()
Returns a pair of longs with the upper address value in the range of this individual address or subnet.
|
IPv6Address |
withoutPrefixLength()
Provides the same address with no prefix.
|
applyToBounds, contains, contains, containsNonZeroHosts, getBitCount, getBitsPerSegment, getBlockMaskPrefixLength, getByteCount, getBytesPerSegment, getIPVersion, getLeadingBitCount, getMatchesSQLClause, getMatchesSQLClause, getMaxSegmentValue, getNetworkPrefixLength, getNonZeroHostCount, getSegmentCount, getSequentialBlockCount, getTrailingBitCount, includesMaxHost, includesMaxHost, includesZeroHost, includesZeroHost, isAnyLocal, isIPAddress, isIPv4, isSingleNetwork, isUnspecified, isZeroHost, isZeroHost, matches, matchesWithMask, mergeToDualPrefixBlocks, mergeToDualSequentialBlocks, overlaps, overlaps, prefixContains, removeBitCountPrefixLength, toAddressString, toAllStrings, toCanonicalHostName, toDelimitedSQLStrs, toHostName, toIPAddress, toNormalizedString, toNormalizedString, toReverseDNSLookupString, toStandardStrings, toStringscontainsPrefixBlock, containsSinglePrefixBlock, defaultIpv4Network, defaultIpv6Network, defaultMACNetwork, equals, getBlockCount, getBytes, getBytes, getBytes, getCount, getDivisionCount, getDivisionStrings, getMinPrefixLengthForBlock, getPrefixCount, getPrefixCount, getPrefixLength, getPrefixLengthForSingleBlock, getSegments, getSegments, getSegmentStrings, getUpperBytes, getUpperBytes, getUpperBytes, getUpperValue, getValue, includesMax, includesZero, isFullRange, isMACAddress, isMax, isMultiple, isPrefixBlock, isPrefixed, isSequential, isSinglePrefixBlock, isZero, matchOrdered, matchUnordered, prefixEquals, toMACAddress, toStringgetPrefixLenComparatorgetPrefixLength, isPrefixBlock, isPrefixedgetSegments, getSegments, getSegmentStrings, isOneBit, testBitgetBlockCount, getCount, getDivisionStrings, getPrefixCount, getPrefixCount, getPrefixLength, getSequentialBlockIndex, isMore, isPrefixBlock, isPrefixed, isSequential, isSinglePrefixBlockgetDivisionCountstream, streamcompareTo, containsPrefixBlock, containsSinglePrefixBlock, getBitsForCount, getBlockSize, getBytes, getBytes, getBytes, getMinPrefixLengthForBlock, getPrefixLengthForSingleBlock, getUpperBytes, getUpperBytes, getUpperBytes, getUpperValue, getValue, includesMax, includesZero, isFullRange, isMax, isMultiple, isZeroisSequentialpublic static final char SEGMENT_SEPARATOR
public static final char ZONE_SEPARATOR
public static final char ALTERNATIVE_ZONE_SEPARATOR
public static final char UNC_SEGMENT_SEPARATOR
public static final char UNC_ZONE_SEPARATOR
public static final char UNC_RANGE_SEPARATOR
public static final String UNC_RANGE_SEPARATOR_STR
public static final String UNC_SUFFIX
public static final String REVERSE_DNS_SUFFIX
public static final String REVERSE_DNS_SUFFIX_DEPRECATED
public static final int BITS_PER_SEGMENT
public static final int BYTES_PER_SEGMENT
public static final int SEGMENT_COUNT
public static final int MIXED_REPLACED_SEGMENT_COUNT
public static final int MIXED_ORIGINAL_SEGMENT_COUNT
public static final int BYTE_COUNT
public static final int BIT_COUNT
public static final int DEFAULT_TEXTUAL_RADIX
public static final int BASE_85_RADIX
public static final int MAX_VALUE_PER_SEGMENT
public IPv6Address(IPv6AddressSection section, IPv6Address.IPv6Zone zone) throws AddressValueException
section - zone - AddressValueException - if segment count is not 8 or zone is invalid@Deprecated public IPv6Address(IPv6AddressSection section, CharSequence zone) throws AddressValueException
IPv6Address(IPv6AddressSection, IPv6Zone)section - zone - AddressValueException - if segment count is not 8 or zone is invalidpublic IPv6Address(IPv6AddressSection section) throws AddressValueException
AddressValueExceptionpublic IPv6Address(IPv6AddressSegment[] segments) throws AddressValueException
segments - the address segmentsAddressValueException - if segment count is not 8public IPv6Address(IPv6AddressSegment[] segments, Integer networkPrefixLength) throws AddressValueException
segments - the address segmentsnetworkPrefixLength - AddressValueException - if segment count is not 8AddressValueException - if network prefix length invalid@Deprecated public IPv6Address(IPv6AddressSegment[] segments, CharSequence zone) throws AddressValueException
IPv6Address(IPv6AddressSegment[], IPv6Zone)segments - the address segmentszone - the zone or scope idAddressValueException - if segment count is not 8 or the zone invalidpublic IPv6Address(IPv6AddressSegment[] segments, IPv6Address.IPv6Zone zone) throws AddressValueException
segments - the address segmentszone - the zone or scope idAddressValueException - if segment count is not 8 or the zone invalidpublic IPv6Address(Inet6Address inet6Address)
inet6Address - the java.net address objectpublic IPv6Address(Inet6Address inet6Address, Integer networkPrefixLength)
inet6Address - the java.net address object@Deprecated public IPv6Address(byte[] bytes, CharSequence zone) throws AddressValueException
IPv6Address(byte[], IPv6Zone)The byte array can be a 16 byte IPv6 address, but may have additional zero-valued bytes, or it may be fewer than 16 bytes.
bytes - the 16 byte IPv6 address in network byte order - if longer than 16 bytes the additional bytes must be zero (and are ignored), if shorter than 16 bytes then the bytes are sign-extended to 16 bytes.AddressValueException - if bytes not equivalent to a 16 byte addressAddressValueException - if byte range invalid or zone invalidpublic IPv6Address(byte[] bytes,
IPv6Address.IPv6Zone zone)
throws AddressValueException
The byte array can be a 16 byte IPv6 address, but may have additional zero-valued bytes, or it may be fewer than 16 bytes.
bytes - the 16 byte IPv6 address in network byte order - if longer than 16 bytes the additional bytes must be zero (and are ignored), if shorter than 16 bytes then the bytes are sign-extended to 16 bytes.AddressValueException - if bytes not equivalent to a 16 byte addressAddressValueException - if byte range invalid or zone invalidpublic IPv6Address(byte[] bytes)
throws AddressValueException
The byte array can be a 16 byte IPv6 address, but may have additional zero-valued bytes, or it may be fewer than 16 bytes.
bytes - the 16 byte IPv6 address in network byte order - if longer than 16 bytes the additional bytes must be zero (and are ignored), if shorter than 16 bytes then the bytes are sign-extended to 16 bytes.AddressValueException - if bytes not equivalent to a 16 byte addresspublic IPv6Address(byte[] bytes,
int byteStartIndex,
int byteEndIndex)
throws AddressValueException
Similar to IPv6Address(byte[]) except that you can specify the start and end of the address in the given byte array.
AddressValueException - if byte range invalidpublic IPv6Address(byte[] bytes,
Integer networkPrefixLength)
throws AddressValueException
The byte array can be a 16 byte IPv6 address, but may have additional zero-valued bytes, or it may be fewer than 16 bytes.
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.
bytes - the 16 byte IPv6 address in network byte order - if longer than 16 bytes the additional bytes must be zero (and are ignored), if shorter than 16 bytes then the bytes are sign-extended to 16 bytes.networkPrefixLength - the CIDR prefix, which can be null for no prefix lengthAddressValueException - if bytes not equivalent to a 16 byte addresspublic IPv6Address(byte[] bytes,
int byteStartIndex,
int byteEndIndex,
Integer networkPrefixLength)
throws AddressValueException
Similar to IPv6Address(byte[], Integer) except that you can specify the start and end of the address in the given byte array.
AddressValueExceptionpublic IPv6Address(BigInteger val) throws AddressValueException
The byte representation from BigInteger.toByteArray() is used, and the byte array follows the rules according to IPv6Address(byte[]).
Either it must be exactly 16 bytes, or if larger then any extra bytes must be significant leading zeros,
or if smaller it is sign-extended to the required 16 byte length.
This means that you can end up with the same address from two different values of BigInteger, one positive and one negative. For instance, -1 and ffffffffffffffffffffffffffffffff are represented by the two's complement byte arrays [ff,ff,ff,ff,ff,ff,ff,ff,ff,ff,ff,ff,ff,ff,ff,ff] and [0,ff,ff,ff,ff,ff,ff,ff,ff,ff,ff,ff,ff,ff,ff,ff,ff] respectively. Both create the address ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff
In fact, the two's complement byte array [ff,ff,ff,ff,ff,ff,ff,ff,ff,ff,ff,ff,ff,ff,ff,ff] can be shortened to [ff], the former being the sign-extension of the latter. So the byte array [ff] also creates the address ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff.
When using positive integers you end up with the results you expect, the magnitude of the big integer becomes the address.
When ranging over all 16-byte arrays and constructing BigInteger from those arrays, you range over all possible addresses.
val - must be an IPv6 address value.AddressValueException - if value is outside the range of potential valuesAddressValueException - if val is invalidpublic IPv6Address(BigInteger val, Integer networkPrefixLength) throws AddressValueException
The byte representation from BigInteger.toByteArray() is used, and the byte array follows the rules according to IPv6Address(byte[]).
Either it must be exactly 16 bytes, or if larger then any extra bytes must be significant leading zeros,
or if smaller it is sign-extended to the required 16 byte length.
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.
val - networkPrefixLength - AddressValueException - if val is invalid@Deprecated public IPv6Address(BigInteger val, CharSequence zone) throws AddressValueException
IPv6Address(BigInteger, IPv6Zone)
The byte representation from BigInteger.toByteArray() is used, and the byte array follows the rules according to IPv6Address(byte[]).
Either it must be exactly 16 bytes, or if larger then any extra bytes must be significant leading zeros,
or if smaller it is sign-extended to the required 16 byte length.
val - zone - AddressValueException - if val is invalid or if zone is invalidpublic IPv6Address(BigInteger val, IPv6Address.IPv6Zone zone) throws AddressValueException
The byte representation from BigInteger.toByteArray() is used, and the byte array follows the rules according to IPv6Address(byte[]).
Either it must be exactly 16 bytes, or if larger then any extra bytes must be significant leading zeros,
or if smaller it is sign-extended to the required 16 byte length.
val - zone - AddressValueException - if val is invalid or if zone is invalid@Deprecated public IPv6Address(BigInteger val, Integer networkPrefixLength, CharSequence zone) throws AddressValueException
IPv6Address(BigInteger, Integer, IPv6Zone)
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.
val - must be an IPv6 address valuenetworkPrefixLength - the CIDR prefix length, which can be null for no prefix lengthzone - the zone or scope idAddressValueException - if value is outside the range of potential values, or if zone is invalidpublic IPv6Address(BigInteger val, Integer networkPrefixLength, IPv6Address.IPv6Zone zone) throws AddressValueException
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.
val - must be an IPv6 address valuenetworkPrefixLength - the CIDR prefix length, which can be null for no prefix lengthzone - the zone or scope idAddressValueException - if value is outside the range of potential values, or if zone is invalidpublic IPv6Address(long highBytes,
long lowBytes,
IPv6Address.IPv6Zone zone)
throws AddressValueException
The highBytes form the more significant 4 bytes of the address.
highBytes - the 4 more significant bytes in network byte orderlowBytes - the 4 least significant bytes in network byte orderAddressValueException - if zone invalidpublic IPv6Address(long highBytes,
long lowBytes)
throws AddressValueException
The highBytes form the more significant 4 bytes of the address.
highBytes - the 4 more significant bytes in network byte orderlowBytes - the 4 least significant bytes in network byte orderAddressValueExceptionpublic IPv6Address(long highBytes,
long lowBytes,
Integer networkPrefixLength)
throws AddressValueException
The highBytes form the more significant 4 bytes of the 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.
highBytes - the 4 more significant bytes in network byte orderlowBytes - the 4 least significant bytes in network byte ordernetworkPrefixLength - the CIDR prefix, which can be null for no prefix lengthAddressValueExceptionpublic IPv6Address(Address.SegmentValueProvider lowerValueProvider, Address.SegmentValueProvider upperValueProvider, Integer networkPrefixLength) throws AddressValueException
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.
lowerValueProvider - supplies the 2 byte lower values for each segmentupperValueProvider - supplies the 2 byte upper values for each segmentnetworkPrefixLength - the CIDR network prefix length, which can be null for no prefixAddressValueExceptionpublic IPv6Address(Address.SegmentValueProvider lowerValueProvider, Address.SegmentValueProvider upperValueProvider)
lowerValueProvider - supplies the 2 byte lower values for each segmentupperValueProvider - supplies the 2 byte upper values for each segmentpublic IPv6Address(Address.SegmentValueProvider valueProvider, Integer networkPrefixLength) throws AddressValueException
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.
valueProvider - supplies the 2 byte value for each segmentnetworkPrefixLength - the CIDR network prefix length, which can be null for no prefixAddressValueExceptionpublic IPv6Address(Address.SegmentValueProvider valueProvider)
valueProvider - supplies the 2 byte value for each segment@Deprecated public IPv6Address(Address.SegmentValueProvider lowerValueProvider, Address.SegmentValueProvider upperValueProvider, CharSequence zone) throws AddressValueException
lowerValueProvider - supplies the 2 byte lower values for each segmentupperValueProvider - supplies the 2 byte upper values for each segmentAddressValueException - if zone is invalidpublic IPv6Address(Address.SegmentValueProvider lowerValueProvider, Address.SegmentValueProvider upperValueProvider, IPv6Address.IPv6Zone zone) throws AddressValueException
lowerValueProvider - supplies the 2 byte lower values for each segmentupperValueProvider - supplies the 2 byte upper values for each segmentAddressValueException - if zone is invalidpublic IPv6Address(IPv6Address prefix, MACAddress eui) throws IncompatibleAddressException
If the supplied MAC section is an 8 byte EUI-64, then it must match the required EUI-64 format of xx-xx-ff-fe-xx-xx with the ff-fe section in the middle. If the supplied section is a 6 byte MAC-48 or EUI-48, then the ff-fe pattern will be inserted.
If the supplied section neither 6 nor 8 bytes, or if the 8-byte section does not have required EUI-64 format of xx-xx-ff-fe-xx-xx,
IncompatibleAddressException will be thrown.
The constructor will toggle the MAC U/L (universal/local) bit as required with EUI-64.
Only the first 8 bytes (4 segments) of the IPv6Address are used to construct the address.
Any prefix length in the MAC address is ignored, while a prefix length in the IPv6 address is preserved but only up to the first 4 segments.
prefix - an address from which the first four segments will be used as the same initial segments in the returned addresseui - IncompatibleAddressException - if the MACAddress is an 8 byte MAC address incompatible with EUI-64 IPv6 formatpublic IPv6Address(IPv6AddressSection section, MACAddress eui) throws IncompatibleAddressException, AddressValueException
If the supplied MAC section is an 8 byte EUI-64, then it must match the required EUI-64 format of xx-xx-ff-fe-xx-xx with the ff-fe section in the middle. If the supplied section is a 6 byte MAC-48 or EUI-48, then the ff-fe pattern will be inserted.
If the supplied section neither 6 nor 8 bytes, or if the 8-byte section does not have required EUI-64 format of xx-xx-ff-fe-xx-xx,
IncompatibleAddressException will be thrown.
The constructor will toggle the MAC U/L (universal/local) bit as required with EUI-64.
The IPv6 address section must be 8 bytes.
Any prefix length in the MAC address is ignored, while a prefix length in the IPv6 address is preserved but only up to the first 4 segments.
section - eui - IncompatibleAddressException - if the MACAddress is an 8 byte MAC address incompatible with EUI-64 IPv6 formatAddressValueException - if the IPv6 section is the wrong size or structurepublic IPv6Address(IPv6AddressSection section, MACAddressSection eui) throws IncompatibleAddressException, AddressValueException
If the supplied address is an 8 byte EUI-64, then it must match the required EUI-64 format of xx-xx-ff-fe-xx-xx with the ff-fe section in the middle. If the supplied address is a 6 byte MAC-48 or EUI-48, then the ff-fe pattern will be inserted.
The constructor will toggle the MAC U/L (universal/local) bit as required with EUI-64.
The IPv6 address section must be 8 bytes.
Any prefix length in the MAC address is ignored, while a prefix length in the IPv6 address is preserved but only up to the first 4 segments.
section - eui - IncompatibleAddressException - if the MACAddress is an 8 byte MAC address incompatible with EUI-64 IPv6 formatAddressValueException - if the MACAddress or IPv6 sections are the wrong size or structure@Deprecated public IPv6Address(IPv6AddressSection section, MACAddressSection eui, CharSequence zone) throws IncompatibleAddressException, AddressValueException
IPv6Address(IPv6AddressSection, MACAddressSection, IPv6Zone)section - eui - zone - IncompatibleAddressException - if the MACAddress is an 8 byte MAC address incompatible with EUI-64 IPv6 formatAddressValueException - if the MACAddress or IPv6 sections are the wrong size or structure, or if zone is invalidpublic IPv6Address(IPv6AddressSection section, MACAddressSection eui, IPv6Address.IPv6Zone zone) throws IncompatibleAddressException, AddressValueException
section - eui - zone - IncompatibleAddressException - if the MACAddress is an 8 byte MAC address incompatible with EUI-64 IPv6 formatAddressValueException - if the MACAddress or IPv6 sections are the wrong size or structure, or if zone is invalidpublic IPv6AddressNetwork getNetwork()
AddressComponentgetNetwork in interface AddressComponentgetNetwork in interface IPAddressStringDivisionSeriesgetNetwork in interface IPAddressSegmentSeriesgetNetwork in class IPAddresspublic MACAddressNetwork getMACNetwork()
public IPv4AddressNetwork getIPv4Network()
public IPv6AddressSection getSection()
IPAddressgetSection in interface AddressSegmentSeriesgetSection in interface IPAddressSegmentSeriesgetSection in class IPAddresspublic IPv6AddressSection getSection(int index)
AddressSegmentSeriesgetSection in interface AddressSegmentSeriesgetSection in interface IPAddressSegmentSeriesgetSection in class IPAddresspublic IPv6AddressSection getSection(int index, int endIndex)
AddressSegmentSeriesgetSection in interface AddressSegmentSeriesgetSection in interface IPAddressSegmentSeriesgetSection in class IPAddresspublic IPv6AddressSegment getDivision(int index)
getDivision in interface AddressDivisionSeriesgetDivision in interface IPAddressDivisionSeriesgetDivision in interface AddressStringDivisionSeriesgetDivision in interface IPAddressStringDivisionSeriespublic IPv6AddressSegment getSegment(int index)
AddressSegmentSeriesAddressDivisionSeries.getDivision(int), the difference being that all segments in a given series are the same bit count, while divisions can have variable length.getSegment in interface AddressSegmentSeriesgetSegment in interface IPAddressSegmentSeriespublic IPv6AddressSegment[] getSegments()
AddressSegmentSeriesAddressSegmentSeries.getSegment(int) and AddressSegmentSeries.getSegmentCount() instead when feasible.getSegments in interface AddressSegmentSeriesgetSegments in interface IPAddressSegmentSeriespublic boolean isEUI64()
public MACAddress toEUI(boolean extended)
public IPAddressStringDivisionSeries[] getParts(IPAddressSection.IPStringBuilderOptions options)
IPAddresspublic IPAddressStringDivisionSeries[] getParts(IPv6AddressSection.IPv6StringBuilderOptions options)
public int getSegmentCount()
AddressSegmentSeriesgetSegmentCount in interface AddressSegmentSeriesgetSegmentCount in class Addresspublic int getByteCount()
AddressItemgetByteCount in interface AddressItemgetByteCount in class IPAddresspublic int getBitCount()
AddressItemgetBitCount in interface AddressDivisionSeriesgetBitCount in interface AddressItemgetBitCount in class Addresspublic IPv6Address getLowerNonZeroHost()
IPAddressSegmentSeriesIPAddressSegmentSeries.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().getLowerNonZeroHost in interface IPAddressSegmentSeriesgetLowerNonZeroHost in class IPAddresspublic IPv6Address getLower()
AddressSegmentSeriesgetLower in interface AddressSegmentSeriesgetLower in interface AddressComponentRangegetLower in interface IPAddressRangegetLower in interface IPAddressSegmentSeriesgetLower in class IPAddresspublic IPv6Address getUpper()
AddressSegmentSeriesgetUpper in interface AddressSegmentSeriesgetUpper in interface AddressComponentRangegetUpper in interface IPAddressRangegetUpper in interface IPAddressSegmentSeriesgetUpper in class IPAddresspublic long[] longValues()
public long[] upperLongValues()
public IPv6Address replace(int startIndex, int endIndex, IPv6Address replacement, int replacementIndex)
startIndex - endIndex - replacement - replacementIndex - IndexOutOfBoundsExceptionpublic IPv6Address replace(int startIndex, IPv6AddressSection replacement)
startIndex - replacement - IndexOutOfBoundsExceptionpublic IPv6Address reverseBits(boolean perByte)
AddressSegmentSeriesreverseBits in interface AddressComponentreverseBits in interface AddressSegmentSeriesreverseBits in interface IPAddressSegmentSeriesreverseBits in class IPAddressperByte - if true, only the bits in each byte are reversed, if false, then all bits in the component are reversedpublic IPv6Address reverseBytes()
AddressSegmentSeriesreverseBytes in interface AddressComponentreverseBytes in interface AddressSegmentSeriesreverseBytes in interface IPAddressSegmentSeriesreverseBytes in class IPAddresspublic IPv6Address reverseBytesPerSegment()
AddressSegmentSeriesreverseBytesPerSegment in interface AddressSegmentSeriesreverseBytesPerSegment in interface IPAddressSegmentSeriesreverseBytesPerSegment in class IPAddresspublic IPv6Address reverseSegments()
AddressSegmentSeriesIncompatibleAddressException since all address series can reverse their segments.reverseSegments in interface AddressSegmentSeriesreverseSegments in interface IPAddressSegmentSeriesreverseSegments in class IPAddresspublic Iterator<IPv6AddressSegment[]> segmentsNonZeroHostIterator()
IPAddressSegmentSeriessegmentsNonZeroHostIterator in interface IPAddressSegmentSeriespublic Iterator<IPv6AddressSegment[]> segmentsIterator()
AddressSegmentSeriessegmentsIterator in interface AddressSegmentSeriessegmentsIterator in interface IPAddressSegmentSeriespublic AddressComponentRangeSpliterator<IPv6Address,IPv6AddressSegment[]> segmentsSpliterator()
AddressSegmentSeriessegmentsSpliterator in interface AddressSegmentSeriessegmentsSpliterator in interface IPAddressSegmentSeriespublic Stream<IPv6AddressSegment[]> segmentsStream()
AddressSegmentSeriesBaseStream.parallel() on the returned stream.segmentsStream in interface AddressSegmentSeriessegmentsStream in interface IPAddressSegmentSeriespublic Iterator<IPv6Address> prefixBlockIterator()
AddressSegmentSeries
If the series has no prefix length, then this is equivalent to AddressSegmentSeries.iterator()
prefixBlockIterator in interface AddressSegmentSeriesprefixBlockIterator in interface IPAddressSegmentSeriesprefixBlockIterator in class IPAddresspublic AddressComponentSpliterator<IPv6Address> prefixBlockSpliterator()
AddressSegmentSeriesprefixBlockSpliterator in interface AddressSegmentSeriesprefixBlockSpliterator in interface IPAddressSegmentSeriesprefixBlockSpliterator in class IPAddresspublic Stream<IPv6Address> prefixBlockStream()
AddressSegmentSeriesBaseStream.parallel() on the returned stream.prefixBlockStream in interface AddressSegmentSeriesprefixBlockStream in interface IPAddressSegmentSeriesprefixBlockStream in class IPAddresspublic Iterator<IPv6Address> prefixBlockIterator(int prefixLength)
IPAddressRangeprefixBlockIterator in interface IPAddressRangepublic AddressComponentSpliterator<IPv6Address> prefixBlockSpliterator(int prefixLength)
IPAddressRangeprefixBlockSpliterator in interface IPAddressRangepublic Stream<IPv6Address> prefixBlockStream(int prefixLength)
IPAddressRangeBaseStream.parallel() on the returned stream.prefixBlockStream in interface IPAddressRangepublic Iterator<IPv6Address> prefixIterator()
AddressSegmentSeries
If the series has no prefix length, then this is equivalent to AddressSegmentSeries.iterator()
prefixIterator in interface AddressSegmentSeriesprefixIterator in interface IPAddressSegmentSeriesprefixIterator in class IPAddresspublic AddressComponentSpliterator<IPv6Address> prefixSpliterator()
AddressSegmentSeriesprefixSpliterator in interface AddressSegmentSeriesprefixSpliterator in interface IPAddressSegmentSeriesprefixSpliterator in class IPAddresspublic Stream<IPv6Address> prefixStream()
AddressSegmentSeriesBaseStream.parallel() on the returned stream.prefixStream in interface AddressSegmentSeriesprefixStream in interface IPAddressSegmentSeriesprefixStream in class IPAddresspublic Iterator<IPv6Address> prefixIterator(int prefixLength)
IPAddressRangeprefixIterator in interface IPAddressRangepublic AddressComponentSpliterator<IPv6Address> prefixSpliterator(int prefixLength)
IPAddressRangeprefixSpliterator in interface IPAddressRangepublic Stream<IPv6Address> prefixStream(int prefixLength)
IPAddressRangeBaseStream.parallel() on the returned stream.prefixStream in interface IPAddressRangepublic Iterator<IPv6Address> blockIterator(int segmentCount)
IPAddressSegmentSeriesFor instance, given the IPv4 subnet 1-2.3-4.5-6.7, given the count argument 2, it will iterate through 1.3.5-6.7, 1.4.5-6.7, 2.3.5-6.7, 2.4.5-6.7
blockIterator in interface IPAddressSegmentSeriesblockIterator in class IPAddresspublic AddressComponentSpliterator<IPv6Address> blockSpliterator(int segmentCount)
IPAddressSegmentSeriesblockSpliterator in interface IPAddressSegmentSeriesblockSpliterator in class IPAddresspublic Stream<IPv6Address> blockStream(int segmentCount)
IPAddressSegmentSeriesBaseStream.parallel() on the returned stream.blockStream in interface IPAddressSegmentSeriesblockStream in class IPAddresspublic Iterator<IPv6Address> sequentialBlockIterator()
IPAddressSegmentSeriesIPAddressSegmentSeries.blockIterator(int) with that segment count.
For instance, given the IPv4 subnet 1-2.3-4.5-6.7-8, it will iterate through 1.3.5.7-8, 1.3.6.7-8, 1.4.5.7-8, 1.4.6.7-8, 2.3.5.7-8, 2.3.6.7-8, 2.4.6.7-8, 2.4.6.7-8.
Use IPAddressSegmentSeries.getSequentialBlockCount() to get the count of iterated elements.
sequentialBlockIterator in interface IPAddressSegmentSeriessequentialBlockIterator in class IPAddresspublic AddressComponentSpliterator<IPv6Address> sequentialBlockSpliterator()
IPAddressSegmentSeriessequentialBlockSpliterator in interface IPAddressSegmentSeriessequentialBlockSpliterator in class IPAddresspublic Stream<IPv6Address> sequentialBlockStream()
IPAddressSegmentSeriesBaseStream.parallel() on the returned stream.
Use IPAddressSegmentSeries.getSequentialBlockCount() to get the count of streamed elements.
sequentialBlockStream in interface IPAddressSegmentSeriessequentialBlockStream in class IPAddresspublic Iterator<IPv6Address> iterator()
AddressComponentRangeAn address component can represent an individual segment, address, or section, or it can represent multiple, typically a subnet of addresses or a range of segment or section values.
Call AddressItem.isMultiple() to determine if this instance represents multiple, or AddressItem.getCount() for the count.
iterator in interface AddressSegmentSeriesiterator in interface AddressComponentRangeiterator in interface IPAddressRangeiterator in interface IPAddressSegmentSeriesiterator in interface Iterable<IPv6Address>iterator in class IPAddresspublic AddressComponentSpliterator<IPv6Address> spliterator()
AddressComponentRangespliterator in interface AddressComponentspliterator in interface AddressSegmentSeriesspliterator in interface AddressComponentRangespliterator in interface IPAddressRangespliterator in interface IPAddressSegmentSeriesspliterator in interface Iterable<IPv6Address>spliterator in class IPAddresspublic Stream<IPv6Address> stream()
AddressComponentRangeBaseStream.parallel() on the returned stream.stream in interface AddressSegmentSeriesstream in interface AddressComponentRangestream in interface IPAddressSegmentSeriesstream in class IPAddresspublic Iterator<IPv6Address> nonZeroHostIterator()
IPAddressSegmentSeriesnonZeroHostIterator in interface IPAddressSegmentSeriesnonZeroHostIterator in class IPAddresspublic Iterable<IPv6Address> getIterable()
AddressComponentRangeAddressComponentRange.iterator() directly.getIterable in interface AddressSegmentSeriesgetIterable in interface AddressComponentRangegetIterable in interface IPAddressRangegetIterable in interface IPAddressSegmentSeriesgetIterable in class IPAddresspublic IPv6Address increment(BigInteger increment)
public IPv6Address increment(long increment)
AddressSegmentSeriesIf the subnet has multiple values and the increment exceeds the subnet size, then the amount by which it exceeds the size - 1 is added to the upper series of the range (the final iterator value).
If the increment is negative, it is added to the lower series of the range (the first iterator value).
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 AddressSegmentSeries.iterator()
For instance, a increment of 0 is the first value from the iterator, an increment of 1 is the second value from the iterator, and so on.
A negative increment added to the subnet count is equivalent to the same number of values preceding the upper bound of the iterator.
For instance, an increment of count - 1 is the last value from the iterator, an increment of count - 2 is the second last value, and so on.
An increment of size count gives you the series just above the highest series of the subnet. To get the series just below the lowest series of the subnet, use the increment -1.
increment in interface AddressSegmentSeriesincrement in interface IPAddressSegmentSeriesincrement in class IPAddresspublic IPv6Address incrementBoundary(long increment)
AddressSegmentSeriesAddressSegmentSeries.getUpper()) in the subnet range to produce a new series.
If the given increment is negative, adds the value to the lower series (AddressSegmentSeries.getLower()) in the subnet range to produce a new series.
If the increment is zero, returns this.
In the case where the series is a single value, this simply returns the address produced by adding the given increment to this address series.
incrementBoundary in interface AddressSegmentSeriesincrementBoundary in interface IPAddressSegmentSeriesincrementBoundary in class IPAddresspublic IPv4Address toIPv4()
You can also use isIPv4Convertible() to determine convertibility. Both use an instance of IPAddressConverter.DefaultAddressConverter which uses IPv4-mapped address mappings from rfc 4038.
Override this method and isIPv4Convertible() if you wish to map IPv6 to IPv4 according to the mappings defined by
in isIPv4Compatible(), isIPv4Mapped(), is6To4() or by some other mapping.
For the reverse mapping, see IPv4Address.toIPv6()
toIPv4 in class IPAddressIPAddress.isIPv4Convertible()public IPv6Address toIPv6()
toIPv6 in class IPAddressIPv6Address. Otherwise, returns null.IPAddress.isIPv6Convertible()public boolean isIPv4Convertible()
toIPv4() to match the conversion.isIPv4Convertible in class IPAddresspublic boolean isIPv6Convertible()
IPAddressIPv4Address.getIPv4MappedAddress()
You should also override IPAddress.toIPv6() to match the conversion.
This method returns true for all IPv6 addresses.isIPv6Convertible in class IPAddresspublic IPv4AddressSection toMappedIPv4Segments()
public IPv4Address get6To4IPv4Address()
IPv4Address.
This can be used for IPv4 or for IPv6 6to4 addresses convertible to IPv4.public IPv4Address getEmbeddedIPv4Address()
IPv4Address in the lowest (least-significant) two segments.
This is used by IPv4-mapped, IPv4-compatible, ISATAP addresses and 6over4 addressesIPv4Addresspublic IPv4Address getEmbeddedIPv4Address(int byteIndex)
byteIndex - the byte index to startIndexOutOfBoundsException - if the index is less than zero or bigger than 7public boolean isLocal()
IPAddresspublic boolean isLinkLocal()
IPAddressisLinkLocal in class IPAddressInetAddress.isLinkLocalAddress()public boolean isSiteLocal()
InetAddress.isSiteLocalAddress()public boolean isUniqueLocal()
public boolean isIPv4Mapped()
public boolean isIPv4Compatible()
Inet6Address.isIPv4CompatibleAddress()public boolean is6To4()
get6To4IPv4Address()public boolean is6Over4()
public boolean isTeredo()
public boolean isIsatap()
public boolean isIPv4Translatable()
public boolean isWellKnownIPv4Translatable()
public boolean isMulticast()
AddressisMulticast in class AddressInetAddress.isMulticastAddress()public boolean isLoopback()
isLoopback in class IPAddressInetAddress.isLoopbackAddress()public IPv6Address intersect(IPAddress other) throws AddressConversionException
IPAddressThis 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.
intersect in class IPAddressAddressConversionException - if the address argument could not be converted to the same address version as thispublic IPv6Address[] subtract(IPAddress other) throws AddressConversionException
IPAddressComputes 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.
subtract in class IPAddressAddressConversionException - if the address argument could not be converted to the same address version as thispublic IPv6Address adjustPrefixBySegment(boolean nextSegment)
AddressSegmentSeries
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.
To avoid the zeroing behaviour, use AddressSegmentSeries.adjustPrefixBySegment(boolean, boolean) with second arg false.
adjustPrefixBySegment in interface AddressSegmentSeriesadjustPrefixBySegment in interface IPAddressSegmentSeriesadjustPrefixBySegment in class IPAddressnextSegment - whether to move prefix to previous or following segment boundarypublic IPv6Address adjustPrefixBySegment(boolean nextSegment, boolean zeroed)
AddressSegmentSeriesadjustPrefixBySegment in interface AddressSegmentSeriesadjustPrefixBySegment in interface IPAddressSegmentSeriesadjustPrefixBySegment in class IPAddressnextSegment - whether to move prefix to previous or following segment boundaryzeroed - whether the bits that move from one side of the prefix to the other become zero or retain their original valuespublic IPv6Address adjustPrefixLength(int adjustment)
IPAddress
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
adjustPrefixLength in interface AddressSegmentSeriesadjustPrefixLength in interface IPAddressSegmentSeriesadjustPrefixLength in class IPAddresspublic IPv6Address adjustPrefixLength(int adjustment, boolean zeroed)
AddressSegmentSeriesadjustPrefixLength in interface AddressSegmentSeriesadjustPrefixLength in interface IPAddressSegmentSeriesadjustPrefixLength in class IPAddressadjustment - the incrementzeroed - whether the bits that move from one side of the prefix to the other become zero or retain their original valuespublic IPv6Address setPrefixLength(int prefixLength) throws PrefixLenException
AddressSegmentSeries
If this series has a prefix length, and the prefix length is increased, the bits moved within the prefix become zero.
For an alternative that does not set bits to zero, use AddressSegmentSeries.setPrefixLength(int, boolean) with the second argument as false.
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.
setPrefixLength in interface AddressSegmentSeriessetPrefixLength in interface IPAddressSegmentSeriessetPrefixLength in class IPAddressPrefixLenExceptionpublic IPv6Address setPrefixLength(int prefixLength, boolean zeroed) throws PrefixLenException
AddressSegmentSeriesWhen the prefix is extended beyond the segment series boundary, it is removed.
setPrefixLength in interface AddressSegmentSeriessetPrefixLength in interface IPAddressSegmentSeriessetPrefixLength in class IPAddresszeroed - 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.PrefixLenExceptionpublic IPv6Address setPrefixLength(int prefixLength, boolean zeroed, boolean zeroHostIsBlock) throws PrefixLenException
IPAddressIPAddress.setPrefixLength(int, boolean) and IPAddress.setPrefixLength(int)
use a value of true for zeroed and for zeroHostIsBlock.
For example, when zeroHostIsBlock is true, applying to 1.2.0.0 the prefix length 16 results in 1.2.*.*/16
Or if you start with 1.2.0.0/24, setting the prefix length to 16 results in a zero host followed by the existing prefix block, which is then converted to a full prefix block, 1.2.*.*/16
When both zeroed and zeroHostIsBlock are true, applying the prefiix length of 16 to 1.2.4.0/24 also results in a zero host followed by the existing prefix block, which is then converted to a full prefix block, 1.2.*.*/16.
When both zeroed and zeroHostIsBlock are false, the resulting address always encompasses the same set of addresses as the original, albeit with a different prefix length.
setPrefixLength in class IPAddressPrefixLenException@Deprecated public IPv6Address applyPrefixLength(int networkPrefixLength) throws PrefixLenException
AddressSegmentSeries
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.
applyPrefixLength in interface AddressSegmentSeriesapplyPrefixLength in interface IPAddressSegmentSeriesapplyPrefixLength in class IPAddressPrefixLenExceptionAddressSegmentSeries.setPrefixLength(int)@Deprecated public IPv6Address removePrefixLength()
AddressSegmentSeries
If the series already has a prefix length, the bits outside the prefix become zero.
Use AddressSegmentSeries.withoutPrefixLength() to remove the prefix length without changing the series values.
Equivalent to calling removePrefixLength(true)
removePrefixLength in interface AddressSegmentSeriesremovePrefixLength in interface IPAddressSegmentSeriesremovePrefixLength in class IPAddressfor an alternative which does not change the address series values.public IPv6Address withoutPrefixLength()
AddressSegmentSeries
Use AddressSegmentSeries.removePrefixLength() as an alternative that deletes the host at the same time by zeroing the host values.
withoutPrefixLength in interface AddressSegmentSerieswithoutPrefixLength in interface IPAddressSegmentSerieswithoutPrefixLength in class IPAddress@Deprecated public IPv6Address removePrefixLength(boolean zeroed)
AddressSegmentSeriesAddressSegmentSeries.removePrefixLength()removePrefixLength in interface AddressSegmentSeriesremovePrefixLength in interface IPAddressSegmentSeriesremovePrefixLength in class IPAddresszeroed - whether the bits outside the prefix become zeropublic IPv6Address toZeroHost()
IPAddressSegmentSeries
The default behaviour is that the resultant series will have the same prefix length.
The resultant series will not have a prefix length if AddressNetwork.getPrefixConfiguration() is AddressNetwork.PrefixConfiguration.ALL_PREFIXED_ADDRESSES_ARE_SUBNETS.
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
toZeroHost in interface IPAddressSegmentSeriestoZeroHost in class IPAddressIPAddressSegmentSeries.toZeroNetwork()public IPv6Address toZeroHost(int prefixLength)
IPAddressSegmentSeriesIf 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
toZeroHost in interface IPAddressSegmentSeriestoZeroHost in class IPAddresspublic IPv6Address toZeroNetwork()
IPAddressSegmentSeries
The default behaviour is that the resultant series will have the same prefix length.
The resultant series will not have a prefix length if AddressNetwork.getPrefixConfiguration() is AddressNetwork.PrefixConfiguration.ALL_PREFIXED_ADDRESSES_ARE_SUBNETS.
toZeroNetwork in interface IPAddressSegmentSeriestoZeroNetwork in class IPAddressIPAddressSegmentSeries.toZeroHost()public IPv6Address toMaxHost()
IPAddressSegmentSeries
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
toMaxHost in interface IPAddressSegmentSeriestoMaxHost in class IPAddresspublic IPv6Address toMaxHost(int prefixLength)
IPAddressSegmentSeriesIf 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
toMaxHost in interface IPAddressSegmentSeriestoMaxHost in class IPAddresspublic IPv6Address mask(IPAddress mask, boolean retainPrefix) throws IncompatibleAddressException, AddressConversionException
IPAddress
If the mask is a different version than this, then the default conversion is applied to the other address 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.
mask in class IPAddressIncompatibleAddressException - 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 segmentAddressConversionException - if the address argument could not be converted to the same address version as thispublic IPv6Address mask(IPAddress mask) throws IncompatibleAddressException, AddressConversionException
IPAddressIPAddress.mask(IPAddress, boolean) with the second argument as false.
If the mask is a different version than this, then the default conversion is applied to the other address first using IPAddress.toIPv4() or IPAddress.toIPv6()
mask in class IPAddressIncompatibleAddressException - 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 segmentAddressConversionException - if the address argument could not be converted to the same address version as thispublic IPv6Address maskNetwork(IPAddress mask, int networkPrefixLength) throws IncompatibleAddressException, PrefixLenException, AddressConversionException
IPAddressAny 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 to the other address 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.
maskNetwork in class IPAddressIncompatibleAddressException - 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 segmentAddressConversionException - if the address argument could not be converted to the same address version as thisPrefixLenExceptionpublic IPv6Address bitwiseOr(IPAddress mask, boolean retainPrefix) throws IncompatibleAddressException, AddressConversionException
IPAddress
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 to the other address first using IPAddress.toIPv4() or IPAddress.toIPv6()
If you wish to mask a section 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
bitwiseOr in class IPAddressIncompatibleAddressException - 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 segmentAddressConversionException - if the address argument could not be converted to the same address version as thispublic IPv6Address bitwiseOr(IPAddress mask) throws IncompatibleAddressException, AddressConversionException
IPAddressIPAddress.bitwiseOr(IPAddress, boolean) with the second argument as false.
If the mask is a different version than this, then the default conversion is applied to the other address first using IPAddress.toIPv4() or IPAddress.toIPv6()
bitwiseOr in class IPAddressIncompatibleAddressException - 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 segmentAddressConversionException - if the address argument could not be converted to the same address version as thispublic IPv6Address bitwiseOrNetwork(IPAddress mask, int networkPrefixLength) throws IncompatibleAddressException, PrefixLenException, AddressConversionException
IPAddress
If the mask is a different version than this, then the default conversion is applied to the other address 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.
bitwiseOrNetwork in class IPAddressnetworkPrefixLength - the new prefix length for the addressIncompatibleAddressException - 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 segmentAddressConversionException - if the address argument could not be converted to the same address version as thisPrefixLenExceptionpublic IPv6Address getHostMask()
IPAddressSegmentSeriesgetHostMask in interface IPAddressSegmentSeriesgetHostMask in class IPAddresspublic IPv6Address getNetworkMask()
IPAddressSegmentSeriesgetNetworkMask in interface IPAddressSegmentSeriesgetNetworkMask in class IPAddresspublic IPv6AddressSection getNetworkSection()
IPAddressSegmentSeriesgetNetworkSection in interface IPAddressSegmentSeriespublic IPv6AddressSection getNetworkSection(int networkPrefixLength) throws PrefixLenException
IPAddressSegmentSeriesgetNetworkSection in interface IPAddressSegmentSeriesPrefixLenExceptionpublic IPv6AddressSection getNetworkSection(int networkPrefixLength, boolean withPrefixLength) throws PrefixLenException
IPAddressSegmentSeriesgetNetworkSection in interface IPAddressSegmentSerieswithPrefixLength - whether the resulting section will have networkPrefixLength as the associated prefix length or notPrefixLenExceptionpublic IPv6AddressSection getHostSection(int networkPrefixLength) throws PrefixLenException
IPAddressSegmentSeriesgetHostSection in interface IPAddressSegmentSeriesPrefixLenExceptionpublic IPv6AddressSection getHostSection()
IPAddressSegmentSeriesgetHostSection in interface IPAddressSegmentSeriespublic IPv6Address toPrefixBlock()
IPAddressFor example, if the address is 1.2.3.4/16 it returns the subnet 1.2.*.* /16
toPrefixBlock in interface AddressSegmentSeriestoPrefixBlock in interface IPAddressSegmentSeriestoPrefixBlock in class IPAddresspublic IPv6Address toPrefixBlock(int networkPrefixLength) throws PrefixLenException
IPAddressSegmentSeriestoPrefixBlock in interface IPAddressSegmentSeriestoPrefixBlock in class IPAddressPrefixLenExceptionpublic IPv6Address assignPrefixForSingleBlock()
IPAddressIf 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
assignPrefixForSingleBlock in interface IPAddressSegmentSeriesassignPrefixForSingleBlock in class IPAddressIPAddressSegmentSeries.toPrefixBlock(),
IPAddressSegmentSeries.assignMinPrefixForBlock()public IPv6Address assignMinPrefixForBlock()
IPAddressassignMinPrefixForBlock in interface IPAddressSegmentSeriesassignMinPrefixForBlock in class IPAddressIPAddressSegmentSeries.toPrefixBlock(),
IPAddressSegmentSeries.assignPrefixForSingleBlock()public IPv6Address coverWithPrefixBlock()
IPAddressSegmentSeriescoverWithPrefixBlock in interface IPAddressRangecoverWithPrefixBlock in interface IPAddressSegmentSeriespublic IPv6Address coverWithPrefixBlock(IPAddress other) throws AddressConversionException
IPAddress
If the other address is a different version than this, then the default conversion is applied to the other address first using IPAddress.toIPv4() or IPAddress.toIPv6()
When you have multiple subnets, cover with:
IPAddress block = subnet0.applyToBounds(IPAddress::coverWithPrefixBlock, subnet1, subnet2, ...);
See IPAddress.applyToBounds(java.util.function.BiFunction, IPAddress...)
coverWithPrefixBlock in class IPAddressAddressConversionExceptionpublic IPv6Address[] spanWithPrefixBlocks()
Unlike spanWithPrefixBlocks(IPAddress) this method only includes addresses that are a part of this subnet.
spanWithPrefixBlocks in interface IPAddressRangespanWithPrefixBlocks in interface IPAddressSegmentSeriespublic IPv6Address[] spanWithPrefixBlocks(IPAddress other) throws AddressConversionException
IPAddress
If the other address is a different version than this, then the default conversion is applied to the other address 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.
From the list of returned subnets you can recover the original range (this to other) by converting each to IPAddressRange with IPAddress.toSequentialRange()
and them joining them into a single range with IPAddressSeqRange.join(IPAddressSeqRange...)
When you have multiple subnets, span with:
IPAddress blocks[] = subnet0.applyToBounds(IPAddress::spanWithPrefixBlocks, subnet1, subnet2, ...);
See IPAddress.applyToBounds(java.util.function.BiFunction, IPAddress...)
spanWithPrefixBlocks in class IPAddressAddressConversionExceptionpublic IPv6Address[] spanWithSequentialBlocks() throws AddressConversionException
This array can be shorter than that produced by spanWithPrefixBlocks() and is never longer.
Unlike spanWithSequentialBlocks(IPAddress) this method only includes addresses that are a part of this subnet.
spanWithSequentialBlocks in interface IPAddressRangespanWithSequentialBlocks in interface IPAddressSegmentSeriesAddressConversionExceptionpublic IPv6Address[] spanWithSequentialBlocks(IPAddress other) throws AddressConversionException
IPAddressIndividual block subnets come in the form 1-3.1-4.5.6-8, however that particular subnet is not sequential since address 1.1.5.8 is in the subnet, the next sequential address 1.1.5.9 is not in the subnet, and a higher address 1.2.5.6 is in the subnet. Blocks are sequential when the first segment with a range of values is followed by segments that span all values.
If the other address is a different version than this, then the default conversion is applied to the other address 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.
From the list of returned subnets you can recover the original range (this and other) by converting each to IPAddressRange with IPAddress.toSequentialRange()
and them joining them into a single range with IPAddressSeqRange.join(IPAddressSeqRange...)
When you have multiple subnets, span with:
IPAddress blocks[] = subnet0.applyToBounds(IPAddress::spanWithSequentialBlocks, subnet1, subnet2, ...);
See IPAddress.applyToBounds(java.util.function.BiFunction, IPAddress...)
spanWithSequentialBlocks in class IPAddressAddressConversionExceptionpublic IPv6AddressSeqRange spanWithRange(IPAddress other) throws AddressConversionException
IPAddress
If the other address is a different version than this, then the default conversion is applied to the other address first using IPAddress.toIPv4() or IPAddress.toIPv6()
When you have multiple subnets, span with:
IPAddressSeqRange range = subnet0.applyToBounds(IPAddress::spanWithRange, subnet1, subnet2, ...);
See IPAddress.applyToBounds(java.util.function.BiFunction, IPAddress...)
spanWithRange in class IPAddressAddressConversionExceptionpublic IPv6Address[] mergeToPrefixBlocks(IPAddress... addresses) throws AddressConversionException
IPAddress
For the smallest list of subnets use IPAddress.mergeToSequentialBlocks(IPAddress...).
If any other address in the list is a different version than this, then the default conversion is applied to the other address first using IPAddress.toIPv4() or IPAddress.toIPv6(),
which can result in AddressConversionException
The resulting array is sorted from lowest address value to highest, regardless of the size of each prefix block.
In version 5.3.1 and earlier, the result was sorted from single address to smallest blocks to largest blocks.
For that ordering, sort with IPAddressSegmentSeries.getPrefixLenComparator():
Arrays.sort(result, IPAddressSegmentSeries.getPrefixLenComparator());
The merging process works with sequential blocks. CIDR prefix subnets have just a single sequential block, as does individual addresses. So this method works efficiently for most conventionally-used subnets.
For example, the subnet ::*:*:*:1-ffff has 281474976710656 sequential blocks.
Just like you should avoid iterating through such a large number of blocks,
you should avoid using this method to merge such a subnet,
rather than a subnet like ::1-ffff:*:*:*:* which has 1 sequential block,
or the subnet ::1-ffff:1-ffff:*:*:*:* which has 65535 sequential blocks.
You can use IPAddress.getSequentialBlockCount() to get the sequential block count.
There are alternatives ways to merge into prefix blocks available in this library. Typically this method is most efficient when merging CIDR prefix blocks and/or individual addresses, which is likely to be the case for most users most of the time. It converts to CIDR prefix blocks prior to merging, if not CIDR prefix blocks or individual addresses already.
When merging a large number of blocks that are not prefix blocks nor individual addresses,
it may be more efficient to merge first and then convert to CIDR prefix blocks afterwards.
You can use IPAddress.mergeToSequentialBlocks(IPAddress...) to merge,
and then span each merged element in the result with IPAddressSegmentSeries.spanWithPrefixBlocks(),
giving the same result as this method.
Sequential ranges provide another option.
You can convert to sequential blocks first with IPAddress.sequentialBlockIterator(),
then convert each sequential block to IPAddressSeqRange with IPAddress.toSequentialRange(),
then join those sequential ranges with IPAddressSeqRange.join(IPAddressSeqRange...),
then convert them to CIDR prefix blocks with IPAddressSeqRange.spanWithPrefixBlocks(),
giving the same result as this method.
mergeToPrefixBlocks in class IPAddressaddresses - the addresses to merge with thisAddressConversionExceptionpublic IPv6Address[] mergeToSequentialBlocks(IPAddress... addresses) throws AddressConversionException
IPAddressBlock subnets come in the form 1-3.1-4.5.6-8, however that subnet is not sequential since address 1.1.5.8 is in the subnet, the next sequential address 1.1.5.9 is not in the subnet, and a higher address 1.2.5.6 is in the subnet. Blocks are sequential when the first segment with a range of values is followed by segments that span all values.
This list will eliminate overlaps to produce the smallest list of sequential block subnets, which is the same size or smaller than the list of prefix blocks produced by IPAddress.mergeToPrefixBlocks(IPAddress...)
If the incoming blocks are not sequential, the result could be a longer list, since the list is divided into sequential blocks before merging.
If any other address in the list is a different version than this, then the default conversion is applied to the other address first using IPAddress.toIPv4() or IPAddress.toIPv6(),
which can result in AddressConversionException
The resulting array is sorted by lower address, regardless of the size of each prefix block.
In version 5.3.1 and earlier, the result was sorted from single address to smallest blocks to largest blocks.
For that ordering, sort with IPAddressSegmentSeries.getPrefixLenComparator():
Arrays.sort(result, IPAddressSegmentSeries.getPrefixLenComparator());
See the javadoc for IPAddress.mergeToPrefixBlocks(IPAddress...) for some alternatives for merging subnets.
mergeToSequentialBlocks in class IPAddressaddresses - the addresses to merge with thisAddressConversionExceptionpublic boolean hasZone()
getZone() returns a non-null valuepublic String getZone()
See getIPv6Zone()
public IPv6Address setZone(IPv6Address.IPv6Zone newZone)
removeZone()newZone - public IPv6Address.IPv6Zone getIPv6Zone()
An IPv6 zone distinguishes two IPv6 addresses that are the same.
They are used with link-local addresses fe80::/10 and distinguishes two interfaces to the link-local network, this is known as the zone id.
They are used with site-local addresses to distinguish sites, using the site id, also known as the scope id.
A zone that consists of a scope id is called a scoped zone.
See getZone()
public IPv6Address removeZone()
public Inet6Address toInetAddress()
Address with a zone should check for null.
This will return null if this IPv6 Address has a zone (available from getIPv6Zone()),
that zone references a network interface (IPv6Address.IPv6Zone.referencesInterface is true)
and that network interface (from IPv6Address.IPv6Zone.getAssociatedIntf()) is an IPv4-only interface,
or that interface is not entirely link-local and this address is link-local,
or that interface is not entirely site-local and this address is site-local.
This will return null if this IPv6 Address has a zone (available from getIPv6Zone()) and:
Inet6Address.getByAddress(String, byte[], NetworkInterface)
will throw UnknownHostException when constructed with the same network interface.
If this address is IPv4-mapped, then any associated zone will be discarded, because it is not possible to create an IPv4-mapped Inet6Address with a zone.
toInetAddress in class IPAddresspublic Inet6Address toUpperInetAddress()
IPAddressIPAddress.toInetAddress()toUpperInetAddress in class IPAddress@Deprecated public IPv6AddressSeqRange toSequentialRange(IPAddress other)
IPAddress
If the other address is a different version than this, then the default conversion is applied to the other address first using IPAddress.toIPv4() or IPAddress.toIPv6()
When you have multiple subnets, create a range from lowest to highest with:
IPAddressSeqRange range = subnet0.applyToBounds(IPAddress::toSequentialRange, subnet1, subnet2, ...);
See IPAddress.applyToBounds(java.util.function.BiFunction, IPAddress...)
toSequentialRange in class IPAddresspublic IPv6AddressSeqRange toSequentialRange()
IPAddress
The two will represent the same set of individual addresses if and only if Address.isSequential() is true.
To get a series of ranges that represent the same set of individual addresses use the IPAddress.sequentialBlockIterator() (or IPAddress.prefixIterator()),
and apply this method to each iterated subnet.
If this represents just a single address then the returned instance covers just that single address as well.
toSequentialRange in interface IPAddressRangetoSequentialRange in class IPAddresspublic boolean isSameAddress(Address other)
isSameAddress in class Addresspublic boolean overlaps(Address other)
Addresspublic boolean contains(Address other)
Addresspublic BigInteger enumerate(Address other)
AddressDetermines how many address elements of a subnet precede the given address element, if the address is in the subnet. If above the subnet range, it is the distance to the upper boundary added to the subnet address count less one, and if below the subnet range, the distance to the lower boundary.
In other words, if the given address is not in the subnet but above it, returns the number of addresses preceding the address from the upper subnet boundary, added to one less than the total number of subnet addresses. If the given address is not in the subnet but below it, returns the number of addresses following the address to the lower subnet boundary.
enumerate returns null when the argument is a multi-valued subnet. The argument must be an individual address.
When this address is also single-valued, the returned value is the distance (difference) between this address and the argument address.
enumerate is the inverse of the increment method:
If the given address does not have the same version or type as this subnet or address, then null is returned.
public BigInteger enumerate(IPAddress other)
IPAddress
For more details, see the equivalent method Address.enumerate(Address).
This method satisfies the implementation of IPAddressRange.
enumerate in interface IPAddressRangeenumerate in class IPAddresspublic String toMixedString()
public String toCanonicalString()
toCanonicalString in interface AddressSegmentSeriestoCanonicalString in interface IPAddressRangetoCanonicalString in class Addresspublic String toFullString()
IPAddresstoFullString in interface IPAddressSegmentSeriestoFullString in class IPAddresspublic static String toNormalizedString(IPv6AddressNetwork network, Address.SegmentValueProvider lowerValueProvider, Address.SegmentValueProvider upperValueProvider, Integer prefixLength, CharSequence zone)
lowerValueProvider - upperValueProvider - prefixLength - zone - network - use Address.defaultIpv6Network() if there is no custom network in usepublic String toNormalizedString()
toNormalizedString in interface AddressComponenttoNormalizedString in interface IPAddressRangetoNormalizedString in class Addresspublic String toCompressedString()
toCompressedString in interface AddressSegmentSeriestoCompressedString in class Addresspublic String toSubnetString()
IPAddresstoSubnetString in interface IPAddressSegmentSeriestoSubnetString in class IPAddresspublic String toNormalizedWildcardString()
IPAddresstoNormalizedWildcardString in interface IPAddressSegmentSeriestoNormalizedWildcardString in class IPAddresspublic String toBase85String() throws IncompatibleAddressException
IncompatibleAddressExceptionpublic String toCanonicalWildcardString()
IPAddresstoCanonicalWildcardString in interface IPAddressSegmentSeriestoCanonicalWildcardString in class IPAddresspublic String toCompressedWildcardString()
IPAddresstoCompressedWildcardString in interface IPAddressSegmentSeriestoCompressedWildcardString in class IPAddresspublic String toSQLWildcardString()
IPAddressAddress.SEGMENT_SQL_WILDCARD instead of Address.SEGMENT_WILDCARD and also uses Address.SEGMENT_SQL_SINGLE_WILDCARDtoSQLWildcardString in interface IPAddressSegmentSeriestoSQLWildcardString in class IPAddresspublic String toHexString(boolean with0xPrefix) throws IncompatibleAddressException
AddresstoHexString in interface AddressComponenttoHexString in class AddressIncompatibleAddressExceptionpublic String toBinaryString() throws IncompatibleAddressException
IPAddressIf this section represents a range of values not corresponding to a prefix, then this is printed as a range of two hex values.
toBinaryString in interface IPAddressSegmentSeriestoBinaryString in class IPAddressIncompatibleAddressExceptionpublic String toSegmentedBinaryString()
IPAddressSegmentSeriestoSegmentedBinaryString in interface IPAddressSegmentSeriespublic String toOctalString(boolean with0Prefix) throws IncompatibleAddressException
IPAddressIf this section represents a range of values not corresponding to a prefix, then this is printed as a range of two hex values.
toOctalString in interface IPAddressSegmentSeriestoOctalString in class IPAddressIncompatibleAddressExceptionpublic String toPrefixLengthString()
IPAddresstoPrefixLengthString in interface IPAddressSegmentSeriestoPrefixLengthString in class IPAddresspublic String toConvertedString()
IPAddresstoConvertedString in class IPAddresspublic String toNormalizedString(IPAddressSection.IPStringOptions params)
IPAddresstoNormalizedString in interface IPAddressSegmentSeriestoNormalizedString in class IPAddressparams - the parameters for the address stringpublic String toNormalizedString(IPv6AddressSection.IPv6StringOptions params)
public String toNormalizedString(boolean keepMixed, IPv6AddressSection.IPv6StringOptions params)
keepMixed - if this address was constructed from a string with mixed representation (a:b:c:d:e:f:1.2.3.4), whether to keep it that way (ignored if makeMixed is true in the params argument)params - the parameters for the address stringpublic String toUNCHostName()
IPAddresstoUNCHostName in class IPAddresspublic IPAddressPartStringCollection toStandardStringCollection()
toStandardStringCollection in class IPAddresspublic IPAddressPartStringCollection toAllStringCollection()
toAllStringCollection in class IPAddresspublic IPAddressPartStringCollection toStringCollection(IPAddressSection.IPStringBuilderOptions opts)
toStringCollection in interface IPAddressSegmentSeriestoStringCollection in class IPAddresspublic IPAddressPartStringCollection toStringCollection(IPv6AddressSection.IPv6StringBuilderOptions opts)