- All Superinterfaces:
Serializable
- All Known Implementing Classes:
IPAddressProvider.AdjustedAddressCreator
,IPAddressProvider.AllCreator
,IPAddressProvider.CachedAddressCreator
,IPAddressProvider.CachedAddressProvider
,IPAddressProvider.LoopbackCreator
,IPAddressProvider.MaskCreator
,IPAddressProvider.NullProvider
,IPAddressProvider.VersionedAddressCreator
,ParsedIPAddress
Provides an address corresponding to a parsed string.
- Author:
- sfoley
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic class
static class
static class
static class
static enum
static class
static class
static class
static class
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final IPAddressProvider.NullProvider
static final IPAddressProvider.NullProvider
static final IPAddressProvider.NullProvider
-
Method Summary
Modifier and TypeMethodDescriptiondefault Boolean
contains
(IPAddressProvider other) An optimized contains that does not need to create address objects to return an answer.default Boolean
An optimized contains that does not need to fully parse the other address to return an answer.default IPAddressDivisionSeries
default IPAddressStringParameters
If the address was created by parsing, this provides the parameters used when creating the address.getProviderAddress
(IPAddress.IPVersion version) static IPAddressProvider
getProviderFor
(IPAddress address, IPAddress hostAddress) Wraps an IPAddress for IPAddressString in the cases where no parsing is provided, the address exists alreadydefault IPAddress.IPVersion
default IPAddress
default Integer
default IPAddressSeqRange
getType()
default boolean
default boolean
default boolean
default boolean
default boolean
default boolean
default boolean
default boolean
default boolean
default boolean
default boolean
default boolean
default Boolean
parsedEquals
(IPAddressProvider other) An optimized equality comparison that does not need to create addresses to return an answer.default Boolean
prefixContains
(IPAddressProvider other) An optimized prefix comparison that does not need to create addresses to return an answer.default Boolean
prefixContains
(String other) An optimized prefix comparison that does not need to create addresses to return an answer.default Boolean
prefixEquals
(IPAddressProvider other) An optimized prefix comparison that does not need to create addresses to return an answer.default Boolean
prefixEquals
(String other) An optimized prefix comparison that does not need to fully parse the other address to return an answer.default int
providerCompare
(IPAddressProvider other) default boolean
providerEquals
(IPAddressProvider other) When a value provider produces no value, equality and comparison are based on the enum IPType, which can by null.default int
-
Field Details
-
INVALID_PROVIDER
-
NO_TYPE_PROVIDER
-
EMPTY_PROVIDER
-
-
Method Details
-
getType
IPAddressProvider.IPType getType() -
getProviderHostAddress
- Throws:
IncompatibleAddressException
-
getProviderAddress
- Throws:
IncompatibleAddressException
-
getProviderAddress
- Throws:
IncompatibleAddressException
-
isSequential
default boolean isSequential() -
getProviderSeqRange
-
getProviderMask
-
getDivisionGrouping
- Throws:
IncompatibleAddressException
-
providerCompare
- Throws:
IncompatibleAddressException
-
providerEquals
When a value provider produces no value, equality and comparison are based on the enum IPType, which can by null.- Parameters:
o
-- Returns:
- Throws:
IncompatibleAddressException
-
providerHashCode
- Throws:
IncompatibleAddressException
-
getProviderIPVersion
-
isProvidingIPAddress
default boolean isProvidingIPAddress() -
isProvidingIPv4
default boolean isProvidingIPv4() -
isProvidingIPv6
default boolean isProvidingIPv6() -
isProvidingPrefixOnly
default boolean isProvidingPrefixOnly() -
isProvidingAllAddresses
default boolean isProvidingAllAddresses() -
isProvidingEmpty
default boolean isProvidingEmpty() -
isProvidingMixedIPv6
default boolean isProvidingMixedIPv6() -
isProvidingBase85IPv6
default boolean isProvidingBase85IPv6() -
getProviderNetworkPrefixLength
-
isInvalid
default boolean isInvalid() -
isUninitialized
default boolean isUninitialized() -
contains
An optimized contains that does not need to create address objects to return an answer. Unconventional addresses may require that the address objects are created, in such cases null is returned. Addresses constructed from canonical or normalized representations with no wildcards will not return null.- Parameters:
other
-- Returns:
-
contains
An optimized contains that does not need to fully parse the other address to return an answer. Unconventional addresses may require full parsing, in such cases null is returned. Addresses constructed from canonical or normalized representations with no wildcards will not return null.- Parameters:
other
-- Returns:
-
prefixEquals
An optimized prefix comparison that does not need to fully parse the other address to return an answer. Unconventional addresses may require full parsing, in such cases null is returned. Addresses constructed from canonical or normalized representations with no wildcards will not return null.- Parameters:
other
-- Returns:
-
prefixEquals
An optimized prefix comparison that does not need to create addresses to return an answer. Unconventional addresses may require the address objects, in such cases null is returned.- Parameters:
other
-- Returns:
-
prefixContains
An optimized prefix comparison that does not need to create addresses to return an answer. Unconventional addresses may require the address objects, in such cases null is returned.- Parameters:
other
-- Returns:
-
prefixContains
An optimized prefix comparison that does not need to create addresses to return an answer. Unconventional addresses may require the address objects, in such cases null is returned.- Parameters:
other
-- Returns:
-
parsedEquals
An optimized equality comparison that does not need to create addresses to return an answer. Unconventional addresses may require the address objects, in such cases null is returned.- Parameters:
other
-- Returns:
-
hasPrefixSeparator
default boolean hasPrefixSeparator() -
getParameters
If the address was created by parsing, this provides the parameters used when creating the address.- Returns:
- the parameters used to create the address, or null if no such parameters were used.
-
getProviderFor
Wraps an IPAddress for IPAddressString in the cases where no parsing is provided, the address exists already- Parameters:
value
-- Returns:
-