public class IPAddressStringParameters extends AddressStringParameters implements Comparable<IPAddressStringParameters>
IPAddressString.
The IPAddressString class uses a default permissive IPAddressStringParameters instance when you do not specify one.
If you wish to use parameters different from the default, then use this class. All instances are immutable and must be constructed with the nested Builder class.| Modifier and Type | Class and Description |
|---|---|
static class |
IPAddressStringParameters.Builder |
static class |
IPAddressStringParameters.IPAddressStringFormatParameters |
AddressStringParameters.AddressStringFormatParameters, AddressStringParameters.BuilderBase, AddressStringParameters.RangeParameters| Modifier and Type | Field and Description |
|---|---|
boolean |
allowIPv4 |
boolean |
allowIPv6 |
boolean |
allowMask
Allows masks to follow valid addresses, such as 1.2.3.4/255.255.0.0 which has the mask 255.255.0.0
|
boolean |
allowPrefix
Allows addresses with prefix length like 1.2.0.0/16
Such as an address is interpreted as a subnet.
|
boolean |
allowPrefixOnly
Allows addresses like /64 which are only prefix lenths.
|
static boolean |
DEFAULT_ALLOW_IPV4 |
static boolean |
DEFAULT_ALLOW_IPV6 |
static boolean |
DEFAULT_ALLOW_MASK |
static boolean |
DEFAULT_ALLOW_PREFIX |
static boolean |
DEFAULT_ALLOW_PREFIX_ONLY |
static boolean |
DEFAULT_EMPTY_IS_LOOPBACK |
boolean |
emptyIsLoopback
Whether the zero-length address is interpreted as the loopback.
|
allowAll, allowEmpty, allowSingleSegment, DEFAULT_ALLOW_ALL, DEFAULT_ALLOW_EMPTY, DEFAULT_ALLOW_SINGLE_SEGMENT| Constructor and Description |
|---|
IPAddressStringParameters(boolean allowEmpty,
boolean allowAll,
boolean allowSingleSegment,
boolean emptyIsLoopback,
boolean allowPrefix,
boolean allowMask,
boolean allowPrefixOnly,
boolean allowIPv4,
boolean allowIPv6,
IPv4AddressStringParameters ipv4Options,
IPv6AddressStringParameters ipv6Options) |
| Modifier and Type | Method and Description |
|---|---|
IPAddressStringParameters |
clone()
Creates and returns a copy of this object.
|
int |
compareTo(IPAddressStringParameters o)
Compares this object with the specified object for order.
|
boolean |
equals(Object o)
Indicates whether some other object is "equal to" this one.
|
IPv4AddressStringParameters |
getIPv4Parameters() |
IPv6AddressStringParameters |
getIPv6Parameters() |
int |
hashCode()
Returns a hash code value for the object.
|
IPAddress.IPVersion |
inferVersion() |
IPAddressStringParameters.Builder |
toBuilder() |
IPAddressStringParameters.Builder |
toBuilder(boolean isMixed) |
compareTo, toBuilderpublic static final boolean DEFAULT_ALLOW_PREFIX_ONLY
public static final boolean DEFAULT_EMPTY_IS_LOOPBACK
public static final boolean DEFAULT_ALLOW_PREFIX
public static final boolean DEFAULT_ALLOW_MASK
public static final boolean DEFAULT_ALLOW_IPV4
public static final boolean DEFAULT_ALLOW_IPV6
public final boolean allowPrefixOnly
DEFAULT_ALLOW_PREFIX_ONLYpublic final boolean emptyIsLoopback
public final boolean allowPrefix
DEFAULT_ALLOW_PREFIXpublic final boolean allowMask
If the mask is the mask for a network prefix length, this is interpreted as the subnet for that network prefix length. Otherwise the address is simply masked by the mask. For instance, 1.2.3.4/255.0.255.0 is 1.0.3.0, while 1.2.3.4/255.255.0.0 is 1.2.0.0/16.
allowPrefix,
DEFAULT_ALLOW_MASKpublic final boolean allowIPv6
public final boolean allowIPv4
public IPAddressStringParameters(boolean allowEmpty,
boolean allowAll,
boolean allowSingleSegment,
boolean emptyIsLoopback,
boolean allowPrefix,
boolean allowMask,
boolean allowPrefixOnly,
boolean allowIPv4,
boolean allowIPv6,
IPv4AddressStringParameters ipv4Options,
IPv6AddressStringParameters ipv6Options)
public IPAddress.IPVersion inferVersion()
public IPAddressStringParameters.Builder toBuilder()
public IPAddressStringParameters.Builder toBuilder(boolean isMixed)
public IPv6AddressStringParameters getIPv6Parameters()
public IPv4AddressStringParameters getIPv4Parameters()
public IPAddressStringParameters clone()
java.lang.Objectx, the expression:
will be true, and that the expression:x.clone() != x
will bex.clone().getClass() == x.getClass()
true, but these are not absolute requirements.
While it is typically the case that:
will bex.clone().equals(x)
true, this is not an absolute requirement.
By convention, the returned object should be obtained by calling
super.clone. If a class and all of its superclasses (except
Object) obey this convention, it will be the case that
x.clone().getClass() == x.getClass().
By convention, the object returned by this method should be independent
of this object (which is being cloned). To achieve this independence,
it may be necessary to modify one or more fields of the object returned
by super.clone before returning it. Typically, this means
copying any mutable objects that comprise the internal "deep structure"
of the object being cloned and replacing the references to these
objects with references to the copies. If a class contains only
primitive fields or references to immutable objects, then it is usually
the case that no fields in the object returned by super.clone
need to be modified.
The method clone for class Object performs a
specific cloning operation. First, if the class of this object does
not implement the interface Cloneable, then a
CloneNotSupportedException is thrown. Note that all arrays
are considered to implement the interface Cloneable and that
the return type of the clone method of an array type T[]
is T[] where T is any reference or primitive type.
Otherwise, this method creates a new instance of the class of this
object and initializes all its fields with exactly the contents of
the corresponding fields of this object, as if by assignment; the
contents of the fields are not themselves cloned. Thus, this method
performs a "shallow copy" of this object, not a "deep copy" operation.
The class Object does not itself implement the interface
Cloneable, so calling the clone method on an object
whose class is Object will result in throwing an
exception at run time.
clone in class AddressStringParametersCloneablepublic int compareTo(IPAddressStringParameters o)
java.lang.ComparableThe implementor must ensure sgn(x.compareTo(y)) == -sgn(y.compareTo(x)) for all x and y. (This implies that x.compareTo(y) must throw an exception iff y.compareTo(x) throws an exception.)
The implementor must also ensure that the relation is transitive: (x.compareTo(y)>0 && y.compareTo(z)>0) implies x.compareTo(z)>0.
Finally, the implementor must ensure that x.compareTo(y)==0 implies that sgn(x.compareTo(z)) == sgn(y.compareTo(z)), for all z.
It is strongly recommended, but not strictly required that (x.compareTo(y)==0) == (x.equals(y)). Generally speaking, any class that implements the Comparable interface and violates this condition should clearly indicate this fact. The recommended language is "Note: this class has a natural ordering that is inconsistent with equals."
In the foregoing description, the notation sgn(expression) designates the mathematical signum function, which is defined to return one of -1, 0, or 1 according to whether the value of expression is negative, zero or positive.
compareTo in interface Comparable<IPAddressStringParameters>o - the object to be compared.public boolean equals(Object o)
java.lang.Object
The equals method implements an equivalence relation
on non-null object references:
x, x.equals(x) should return
true.
x and y, x.equals(y)
should return true if and only if
y.equals(x) returns true.
x, y, and z, if
x.equals(y) returns true and
y.equals(z) returns true, then
x.equals(z) should return true.
x and y, multiple invocations of
x.equals(y) consistently return true
or consistently return false, provided no
information used in equals comparisons on the
objects is modified.
x,
x.equals(null) should return false.
The equals method for class Object implements
the most discriminating possible equivalence relation on objects;
that is, for any non-null reference values x and
y, this method returns true if and only
if x and y refer to the same object
(x == y has the value true).
Note that it is generally necessary to override the hashCode
method whenever this method is overridden, so as to maintain the
general contract for the hashCode method, which states
that equal objects must have equal hash codes.
equals in class AddressStringParameterso - the reference object with which to compare.true if this object is the same as the obj
argument; false otherwise.Object.hashCode(),
HashMappublic int hashCode()
java.lang.ObjectHashMap.
The general contract of hashCode is:
hashCode method
must consistently return the same integer, provided no information
used in equals comparisons on the object is modified.
This integer need not remain consistent from one execution of an
application to another execution of the same application.
equals(Object)
method, then calling the hashCode method on each of
the two objects must produce the same integer result.
Object.equals(java.lang.Object)
method, then calling the hashCode method on each of the
two objects must produce distinct integer results. However, the
programmer should be aware that producing distinct integer results
for unequal objects may improve the performance of hash tables.
As much as is reasonably practical, the hashCode method defined by
class Object does return distinct integers for distinct
objects. (This is typically implemented by converting the internal
address of the object into an integer, but this implementation
technique is not required by the
Java™ programming language.)
hashCode in class ObjectObject.equals(java.lang.Object),
System.identityHashCode(java.lang.Object)