public class IPv6Address extends IPAddress implements java.lang.Iterable<IPv6Address>
| Modifier and Type | Class and Description |
|---|---|
static interface |
IPv6Address.IPv6AddressConverter |
IPAddress.IPVersionAddress.AddressProvider, Address.SegmentValueProvider| Modifier and Type | Field and Description |
|---|---|
static char |
ALTERNATIVE_ZONE_SEPARATOR |
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 java.lang.String |
REVERSE_DNS_SUFFIX |
static java.lang.String |
REVERSE_DNS_SUFFIX_DEPRECATED |
static int |
SEGMENT_COUNT |
static char |
SEGMENT_SEPARATOR |
static char |
UNC_RANGE_SEPARATOR |
static java.lang.String |
UNC_RANGE_SEPARATOR_STR |
static char |
UNC_SEGMENT_SEPARATOR |
static java.lang.String |
UNC_SUFFIX |
static char |
UNC_ZONE_SEPARATOR |
static char |
ZONE_SEPARATOR |
DEFAULT_ADDRESS_CONVERTER, PREFIX_LEN_SEPARATORALTERNATIVE_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,
java.lang.CharSequence zone)
Constructs an IPv6 address.
|
IPv6Address(Address.SegmentValueProvider lowerValueProvider,
Address.SegmentValueProvider upperValueProvider,
java.lang.Integer networkPrefixLength)
Constructs an IPv6 address or subnet.
|
IPv6Address(Address.SegmentValueProvider valueProvider,
java.lang.Integer networkPrefixLength)
Constructs an IPv6 address.
|
IPv6Address(java.math.BigInteger val)
Constructs an IPv6 address.
|
IPv6Address(java.math.BigInteger val,
java.lang.Integer networkPrefixLength)
Constructs an IPv6 address or subnet.
|
IPv6Address(byte[] bytes)
Constructs an IPv6 address.
|
IPv6Address(byte[] bytes,
java.lang.CharSequence zone)
Constructs an IPv6 address.
|
IPv6Address(byte[] bytes,
java.lang.Integer networkPrefixLength)
Constructs an IPv6 address or subnet.
|
IPv6Address(java.net.Inet6Address inet6Address)
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,
java.lang.CharSequence zone) |
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,
java.lang.CharSequence zone) |
IPv6Address(IPv6AddressSegment[] segments)
Constructs an IPv6 address or subnet.
|
IPv6Address(IPv6AddressSegment[] segments,
java.lang.CharSequence zone)
Constructs an IPv6 address or a set of addresses.
|
IPv6Address(IPv6AddressSegment[] segments,
java.lang.Integer networkPrefixLength)
Constructs an IPv6 address or a set of addresses.
|
| Modifier and Type | Method and Description |
|---|---|
IPv6Address |
adjustPrefixBySegment(boolean nextSegment)
Increases or decreases prefix length to the next segment boundary.
|
IPv6Address |
adjustPrefixLength(int adjustment)
Increases or decreases prefix length by the given increment.
|
IPv6Address |
applyPrefixLength(int networkPrefixLength)
Applies the given prefix length to create a new segment series.
|
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.
|
boolean |
contains(IPAddress other) |
IPv4Address |
get6to4IPv4Address()
Returns the second and third bytes as an
IPv4Address. |
int |
getBitCount() |
int |
getByteCount()
returns the number of bytes in each of the address components represented by this instance
|
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.
|
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() |
java.lang.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 series of the same version (eg IPv4, IPv6 and MAC each have their own network object)
|
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
|
IPv6AddressSection |
getSection(int index,
int endIndex)
Gets the subsection from the series starting from the given index and ending just before the give endIndex
|
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
If this represents a series with a single value in each segment, returns this.
|
java.lang.String |
getZone() |
int |
hashCode() |
boolean |
hasZone() |
IPv6Address |
intersect(IPAddress other)
Produces the subnet whose addresses are found in both this and the given subnet argument.
|
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 |
isIPv6Convertible()
Determines whether an address can be converted to IPv6, if not IPv6 already.
|
boolean |
isIsatap()
Whether the address is ISATAP
|
boolean |
isLinkLocal() |
boolean |
isLoopback() |
boolean |
isMulticast()
Whether the MAC address or IP address or other form of address is multicast.
|
boolean |
isSameAddress(IPAddress 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
|
java.util.Iterator<IPv6Address> |
iterator()
Iterates through the individual segment series.
|
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.
|
java.util.Iterator<IPv6Address> |
nonZeroHostIterator() |
IPv6Address |
removePrefixLength()
Removes the prefix length.
|
IPv6Address |
removePrefixLength(boolean zeroed)
Removes the prefix length.
|
IPv6Address |
removeZone() |
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 |
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.
|
java.util.Iterator<IPv6AddressSegment[]> |
segmentsIterator()
Iterates through the individual segments.
|
java.util.Iterator<IPv6AddressSegment[]> |
segmentsNonZeroHostIterator() |
IPv6Address |
setPrefixLength(int prefixLength)
Sets the prefix length.
|
IPv6Address |
setPrefixLength(int prefixLength,
boolean zeroed)
Sets the prefix length.
|
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() |
java.lang.String |
toBase85String()
The base 85 string is described by RFC 1924
|
java.lang.String |
toBinaryString()
Writes this address as a single binary value with always the exact same number of characters
|
java.lang.String |
toCanonicalString()
This produces a canonical string.
|
java.lang.String |
toCanonicalWildcardString()
This produces a string similar to the canonical string but avoids the CIDR prefix.
|
java.lang.String |
toCompressedString()
This compresses the maximum number of zeros and/or host segments with the IPv6 compression notation '::'
|
java.lang.String |
toCompressedWildcardString()
This is similar to toNormalizedWildcardString, avoiding the CIDR prefix, but with compression as well.
|
java.lang.String |
toConvertedString()
Returns a mixed string if it represents a convertible IPv4 address, returns the normalized string otherwise.
|
MACAddress |
toEUI(boolean extended) |
java.lang.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.
|
java.lang.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.
|
java.net.Inet6Address |
toInetAddress()
Converts the lowest value of this address to an InetAddress
|
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
|
java.lang.String |
toMixedString() |
java.lang.String |
toNormalizedString()
The normalized string returned by this method is consistent with java.net.Inet6address.
|
java.lang.String |
toNormalizedString(boolean keepMixed,
IPv6AddressSection.IPv6StringOptions params)
Constructs a string representing this address according to the given parameters
|
java.lang.String |
toNormalizedString(IPAddressSection.IPStringOptions params)
Constructs a string representing this address according to the given parameters
|
static java.lang.String |
toNormalizedString(IPv6AddressNetwork network,
Address.SegmentValueProvider lowerValueProvider,
Address.SegmentValueProvider upperValueProvider,
java.lang.Integer prefixLength,
java.lang.CharSequence zone)
Creates the normalized string for an address without having to create the address objects first.
|
java.lang.String |
toNormalizedString(IPv6AddressSection.IPv6StringOptions params) |
java.lang.String |
toNormalizedWildcardString()
This produces a string similar to the normalized string but avoids the CIDR prefix.
|
java.lang.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()
If this series has a prefix length, returns the block for that prefix.
|
IPv6Address |
toPrefixBlock(int networkPrefixLength)
Returns the segment series of the same length that spans all hosts.
|
java.lang.String |
toPrefixLengthString()
Returns a string with a CIDR network prefix length if this address has a network prefix length.
|
java.lang.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) |
java.lang.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.
|
java.lang.String |
toUNCHostName()
Generates the Microsoft UNC path component for this address
|
java.net.Inet6Address |
toUpperInetAddress()
Converts the highest value of this address to an InetAddress.
|
contains, getBitCount, getBitsPerSegment, getBitsPerSegment, getBlockMaskPrefixLength, getByteCount, getBytesPerSegment, getIPVersion, getMatchesSQLClause, getMatchesSQLClause, getMaxSegmentValue, getMaxSegmentValue, getNetworkPrefixLength, getNonZeroHostCount, getSegmentCount, includesZeroHost, isAnyLocal, isIPv4, isIPv6, isLocal, matches, toAddressString, toAllStrings, toCanonicalHostName, toDelimitedSQLStrs, toHostName, toReverseDNSLookupString, toStandardStrings, toStringscompareTo, defaultIpv4Network, defaultIpv6Network, defaultMACNetwork, equals, getBytes, getBytes, getCount, getDivision, getDivisionCount, getDivisionStrings, getMinPrefixLengthForBlock, getPrefixLength, getPrefixLengthForSingleBlock, getSegments, getSegments, getSegmentStrings, getUpperBytes, getUpperBytes, getUpperValue, getValue, isFullRange, isMore, isMultiple, isPrefixBlock, isPrefixed, isSameAddress, isSinglePrefixBlock, isZero, toStringgetSegments, getSegments, getSegmentStringsgetDivision, getDivisionStrings, getMinPrefixLengthForBlock, getPrefixLength, getPrefixLengthForSingleBlock, getUpperValue, getValue, isMore, isPrefixBlock, isPrefixed, isSinglePrefixBlockgetDivisionCountgetBytes, getBytes, getCount, getUpperBytes, getUpperBytes, isFullRange, isMultiple, isZeropublic 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 java.lang.String UNC_RANGE_SEPARATOR_STR
public static final java.lang.String UNC_SUFFIX
public static final java.lang.String REVERSE_DNS_SUFFIX
public static final java.lang.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 MAX_VALUE_PER_SEGMENT
public IPv6Address(IPv6AddressSection section, java.lang.CharSequence zone) throws AddressValueException
section - zone - AddressValueException - if segment count is not 8public IPv6Address(IPv6AddressSection section) throws AddressValueException
AddressValueExceptionpublic IPv6Address(IPv6AddressSegment[] segments) throws AddressValueException
segments - the address segmentsAddressValueException - if segment count is not 8public IPv6Address(IPv6AddressSegment[] segments, java.lang.Integer networkPrefixLength) throws AddressValueException
segments - the address segmentsnetworkPrefixLength - AddressValueException - if segment count is not 8public IPv6Address(IPv6AddressSegment[] segments, java.lang.CharSequence zone) throws AddressValueException
segments - the address segmentszone - the zoneAddressValueException - if segment count is not 8public IPv6Address(java.net.Inet6Address inet6Address)
inet6Address - the java.net address objectpublic IPv6Address(byte[] bytes,
java.lang.CharSequence zone)
throws AddressValueException
bytes - the 16 byte IPv6 address - 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)
throws AddressValueException
bytes - the 16 byte IPv6 address - 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,
java.lang.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.
bytes - the 16 byte IPv6 address - 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(java.math.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 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
This means that when using positive integers you end up with the results you expect, the magnitude of the big integer becomes the address.
Or, this means when ranging over all 16-byte integers, both positive and negative, you range over all possible addresses.
val - must be a 16 byte or less IPv6 address value.AddressValueException - if value is negative or too largepublic IPv6Address(java.math.BigInteger val,
java.lang.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.
val - must be an 16 byte or less IPv6 address valuenetworkPrefixLength - the CIDR prefix, which can be null for no prefix lengthAddressValueException - if value is negative or too largepublic IPv6Address(Address.SegmentValueProvider lowerValueProvider, Address.SegmentValueProvider upperValueProvider, java.lang.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, java.lang.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 segmentpublic IPv6Address(Address.SegmentValueProvider lowerValueProvider, Address.SegmentValueProvider upperValueProvider, java.lang.CharSequence zone)
lowerValueProvider - supplies the 2 byte lower values for each segmentupperValueProvider - supplies the 2 byte upper values for each segmentpublic 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 structurepublic IPv6Address(IPv6AddressSection section, MACAddressSection eui, java.lang.CharSequence 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 structurepublic IPv6AddressNetwork getNetwork()
AddressSegmentSeriesgetNetwork in interface AddressSegmentSeriesgetNetwork in interface IPAddressSegmentSeriesgetNetwork in class IPAddresspublic MACAddressNetwork getMACNetwork()
public IPv4AddressNetwork getIPv4Network()
public IPv6AddressSection getSection()
IPAddressgetSection 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 getSegment(int index)
AddressSegmentSeriesgetSegment in interface AddressSegmentSeriesgetSegment in interface IPAddressSegmentSeriesgetSegment in class IPAddresspublic IPv6AddressSegment[] getSegments()
AddressSegmentSeriesAddressSegmentSeries.getSegment(int) and AddressSegmentSeries.getSegmentCount() instead when feasible.getSegments in interface AddressSegmentSeriesgetSegments in interface IPAddressSegmentSeriesgetSegments in class IPAddresspublic 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()
AddressComponentgetByteCount in interface AddressComponentgetByteCount in class IPAddresspublic int getBitCount()
getBitCount 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 AddressComponentgetLower in interface AddressSegmentSeriesgetLower in interface IPAddressSegmentSeriesgetLower in class IPAddresspublic IPv6Address getUpper()
AddressSegmentSeriesgetUpper in interface AddressComponentgetUpper in interface AddressSegmentSeriesgetUpper in interface IPAddressSegmentSeriesgetUpper in class IPAddresspublic IPv6Address replace(int startIndex, int endIndex, IPv6Address replacement, int replacementIndex)
startIndex - endIndex - replacement - replacementIndex - java.lang.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 java.util.Iterator<IPv6AddressSegment[]> segmentsNonZeroHostIterator()
segmentsNonZeroHostIterator in interface IPAddressSegmentSeriessegmentsNonZeroHostIterator in class IPAddresspublic java.util.Iterator<IPv6AddressSegment[]> segmentsIterator()
AddressSegmentSeriessegmentsIterator in interface AddressSegmentSeriessegmentsIterator in interface IPAddressSegmentSeriessegmentsIterator in class IPAddresspublic java.util.Iterator<IPv6Address> iterator()
AddressSegmentSeriesiterator in interface AddressComponentiterator in interface AddressSegmentSeriesiterator in interface IPAddressSegmentSeriesiterator in interface java.lang.Iterable<IPv6Address>iterator in class IPAddresspublic java.util.Iterator<IPv6Address> nonZeroHostIterator()
nonZeroHostIterator in interface IPAddressSegmentSeriesnonZeroHostIterator in class IPAddresspublic java.lang.Iterable<IPv6Address> getIterable()
AddressComponentAddressComponent.iterator() directly.getIterable in interface AddressComponentgetIterable in interface AddressSegmentSeriesgetIterable in interface IPAddressSegmentSeriesgetIterable in class IPAddresspublic IPv4Address toIPv4()
This uses isIPv4Convertible() to determine convertibility, and that uses 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.public boolean isIPv4Convertible()
toIPv4() to match the conversion.isIPv4Convertible in class IPAddresspublic boolean isIPv6Convertible()
IPAddressIPAddress.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 startjava.lang.IndexOutOfBoundsException - if the index is less than zero or bigger than 7public boolean isLinkLocal()
isLinkLocal in class IPAddressInetAddress.isLinkLocalAddress()public boolean isSiteLocal()
isSiteLocal in class IPAddressInetAddress.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)
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.
public IPv6Address[] subtract(IPAddress other)
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.
public IPv6Address adjustPrefixBySegment(boolean nextSegment)
AddressSegmentSeriesWhen prefix length is increased, the bits moved within the prefix become zero. When a prefix length is decreased, whether the bits moved outside the prefix become zero is dependent on the address type.
adjustPrefixBySegment in interface AddressSegmentSeriesadjustPrefixBySegment in interface IPAddressSegmentSeriesadjustPrefixBySegment in class IPAddresspublic IPv6Address adjustPrefixLength(int adjustment)
AddressSegmentSeriesWhen 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, whether the bits moved outside the prefix become zero is dependent on the address type.
adjustPrefixLength in interface AddressSegmentSeriesadjustPrefixLength in interface IPAddressSegmentSeriesadjustPrefixLength in class IPAddresspublic IPv6Address setPrefixLength(int prefixLength) throws PrefixLenException
AddressSegmentSeriesIf this series has a prefix length, and the prefix length is increased, the bits moved within the prefix become zero.
When the prefix is extended beyond the segment series boundary, it is removed.
When a prefix length is decreased, whether the bits moved outside the prefix become zero is dependent on the address type.
setPrefixLength in interface AddressSegmentSeriessetPrefixLength in interface IPAddressSegmentSeriessetPrefixLength in class IPAddressPrefixLenExceptionAddressSegmentSeries.applyPrefixLength(int)public IPv6Address setPrefixLength(int prefixLength, boolean zeroed) throws PrefixLenException
IPAddressSegmentSeriesIf zeroed is true, and this series has a prefix length, and the prefix length is increased, the bits moved within the prefix become zero. When a prefix length is decreased, whether the bits moved outside the prefix become zero is dependent on the address type.
When the prefix is extended beyond the segment series boundary, it is removed.
setPrefixLength in interface IPAddressSegmentSeriessetPrefixLength in class IPAddressPrefixLenExceptionpublic 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.
With some address types, 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)public IPv6Address removePrefixLength()
AddressSegmentSeriesIf the series already has a prefix length, the bits previously not within the prefix become zero.
removePrefixLength in interface AddressSegmentSeriesremovePrefixLength in interface IPAddressSegmentSeriesremovePrefixLength in class IPAddresspublic IPv6Address removePrefixLength(boolean zeroed)
IPAddressSegmentSeriesIPAddressSegmentSeries.removePrefixLength()removePrefixLength in interface IPAddressSegmentSeriesremovePrefixLength in class IPAddresspublic IPv6Address mask(IPAddress mask, boolean retainPrefix) throws IncompatibleAddressException
IPAddress
If the mask is a different version than this, then the default conversion is applied first using (IPAddress.toIPv4() or IPAddress.toIPv6()
If this represents multiple addresses, and applying the mask to all addresses creates a set of addresses
that cannot be represented as a contiguous range within each segment, then IncompatibleAddressException is thrown.
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 segmentpublic IPv6Address mask(IPAddress mask) throws IncompatibleAddressException
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 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 segmentpublic IPv6Address maskNetwork(IPAddress mask, int networkPrefixLength) throws IncompatibleAddressException, PrefixLenException
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 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 segmentPrefixLenExceptionpublic IPv6Address bitwiseOr(IPAddress mask, boolean retainPrefix) throws IncompatibleAddressException
IPAddress
The mask is applied to all individual addresses, similar to how the IPAddress.mask(IPAddress) method which does the bitwise conjunction.
If the retainPrefix argument is true, then any existing prefix length is removed beforehand.
If the mask is a different version than this, then the default conversion is applied first using (IPAddress.toIPv4() or IPAddress.toIPv6()
If you wish to mask a portion of the network, use IPAddress.bitwiseOrNetwork(IPAddress, int)
For instance, you can get the broadcast address for a subnet as follows:
String addrStr = "1.2.3.4/16";
IPAddress address = new IPAddressString(addrStr).getAddress();
IPAddress hostMask = address.getNetwork().getHostMask(address.getNetworkPrefixLength());//0.0.255.255
IPAddress broadcastAddress = address.bitwiseOr(hostMask); //1.2.255.255
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 segmentpublic IPv6Address bitwiseOr(IPAddress mask) throws IncompatibleAddressException
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 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 segmentpublic IPv6Address bitwiseOrNetwork(IPAddress mask, int networkPrefixLength) throws IncompatibleAddressException, PrefixLenException
IPAddress
If the mask is a different version than this, then the default conversion is applied first using (IPAddress.toIPv4() or IPAddress.toIPv6()
Any existing prefix length is dropped for the new prefix length and the mask is applied up to the end the new prefix length.
It is similar to how the IPAddress.maskNetwork(IPAddress, int) method does the bitwise conjunction.
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 segmentPrefixLenExceptionpublic 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()
AddressSegmentSeriestoPrefixBlock 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 boolean hasZone()
public java.lang.String getZone()
public IPv6Address removeZone()
public java.net.Inet6Address toInetAddress()
IPAddresstoInetAddress in class IPAddresspublic java.net.Inet6Address toUpperInetAddress()
IPAddressIPAddress.toInetAddress()toUpperInetAddress in class IPAddresspublic boolean isSameAddress(IPAddress other)
isSameAddress in class IPAddresspublic boolean contains(IPAddress other)
public java.lang.String toMixedString()
public java.lang.String toCanonicalString()
toCanonicalString in interface AddressSegmentSeriestoCanonicalString in class Addresspublic java.lang.String toFullString()
IPAddresstoFullString in interface IPAddressSegmentSeriestoFullString in class IPAddresspublic static java.lang.String toNormalizedString(IPv6AddressNetwork network, Address.SegmentValueProvider lowerValueProvider, Address.SegmentValueProvider upperValueProvider, java.lang.Integer prefixLength, java.lang.CharSequence zone)
lowerValueProvider - upperValueProvider - prefixLength - zone - public java.lang.String toNormalizedString()
toNormalizedString in interface AddressComponenttoNormalizedString in class Addresspublic java.lang.String toCompressedString()
toCompressedString in interface AddressSegmentSeriestoCompressedString in class Addresspublic java.lang.String toSubnetString()
IPAddresstoSubnetString in interface IPAddressSegmentSeriestoSubnetString in class IPAddresspublic java.lang.String toNormalizedWildcardString()
IPAddresstoNormalizedWildcardString in interface IPAddressSegmentSeriestoNormalizedWildcardString in class IPAddresspublic java.lang.String toBase85String()
public java.lang.String toCanonicalWildcardString()
IPAddresstoCanonicalWildcardString in interface IPAddressSegmentSeriestoCanonicalWildcardString in class IPAddresspublic java.lang.String toCompressedWildcardString()
IPAddresstoCompressedWildcardString in interface IPAddressSegmentSeriestoCompressedWildcardString in class IPAddresspublic java.lang.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 java.lang.String toHexString(boolean with0xPrefix)
AddresstoHexString in interface AddressComponenttoHexString in class Addresspublic java.lang.String toBinaryString()
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 IPAddresspublic java.lang.String toOctalString(boolean with0Prefix)
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 IPAddresspublic java.lang.String toPrefixLengthString()
IPAddresstoPrefixLengthString in interface IPAddressSegmentSeriestoPrefixLengthString in class IPAddresspublic java.lang.String toConvertedString()
IPAddresstoConvertedString in class IPAddresspublic java.lang.String toNormalizedString(IPAddressSection.IPStringOptions params)
IPAddresstoNormalizedString in interface IPAddressSegmentSeriestoNormalizedString in class IPAddressparams - the parameters for the address stringpublic java.lang.String toNormalizedString(IPv6AddressSection.IPv6StringOptions params)
public java.lang.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 java.lang.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)