IPAddressStringParameters

java.lang.Object
- inet.ipaddr.IPAddressStringParameters

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<IPAddressStringParameters>
```
public class IPAddressStringParameters
extends java.lang.Object
implements java.lang.Cloneable, java.lang.Comparable<IPAddressStringParameters>, java.io.Serializable
```
This class allows you to control the validation performed by the class 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.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`IPAddressStringParameters.Builder`
`static class`	`IPAddressStringParameters.IPVersionAddressStringParameters`
`static class`	`IPAddressStringParameters.RangeParameters` Controls special characters in addresses like '*', '-', '_'

Field Summary

Fields
Modifier and Type	Field and Description
`boolean`	`allowAll` Allows the all-encompassing address *, which represents the network of all IPv4 and IPv6 addresses
`boolean`	`allowEmpty` Allows zero-length IPAddressStrings like ""
`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_ALL`
`static boolean`	`DEFAULT_ALLOW_EMPTY`
`static boolean`	`DEFAULT_ALLOW_LEADING_ZEROS`
`static boolean`	`DEFAULT_ALLOW_MASK`
`static boolean`	`DEFAULT_ALLOW_PREFIX`
`static boolean`	`DEFAULT_ALLOW_PREFIX_BEYOND_ADDRESS_SIZE`
`static boolean`	`DEFAULT_ALLOW_PREFIX_LENGTH_LEADING_ZEROS`
`static boolean`	`DEFAULT_ALLOW_PREFIX_ONLY`
`static boolean`	`DEFAULT_ALLOW_UNLIMITED_LEADING_ZEROS`
`static boolean`	`DEFAULT_ALLOW_WILDCARDED_SEPARATOR`
`static boolean`	`DEFAULT_EMPTY_IS_LOOPBACK`
`static IPAddressStringParameters.RangeParameters`	`DEFAULT_RANGE_OPTIONS`
`boolean`	`emptyIsLoopback` Whether the zero-length address is interpreted as the loopback.

Constructor Summary

Constructors
Constructor and Description
`IPAddressStringParameters(boolean allowEmpty, boolean allowAll, boolean emptyIsLoopback, boolean allowPrefix, boolean allowMask, boolean allowPrefixOnly, IPv4AddressStringParameters ipv4Options, IPv6AddressStringParameters ipv6Options)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`IPAddressStringParameters`	`clone()`
`int`	`compareTo(IPAddressStringParameters o)`
`boolean`	`equals(java.lang.Object o)`
`IPv4AddressStringParameters`	`getIPv4Parameters()`
`IPv6AddressStringParameters`	`getIPv6Parameters()`
`int`	`hashCode()`
`IPAddressStringParameters.Builder`	`toBuilder()`
`IPAddressStringParameters.Builder`	`toBuilder(boolean isMixed)`

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

- Field Detail
  - DEFAULT_ALLOW_LEADING_ZEROS
```
public static final boolean DEFAULT_ALLOW_LEADING_ZEROS
```
    See Also:
    
    Constant Field Values
  - DEFAULT_ALLOW_PREFIX_LENGTH_LEADING_ZEROS
```
public static final boolean DEFAULT_ALLOW_PREFIX_LENGTH_LEADING_ZEROS
```
    See Also:
    
    Constant Field Values
  - DEFAULT_ALLOW_UNLIMITED_LEADING_ZEROS
```
public static final boolean DEFAULT_ALLOW_UNLIMITED_LEADING_ZEROS
```
    See Also:
    
    Constant Field Values
  - DEFAULT_ALLOW_EMPTY
```
public static final boolean DEFAULT_ALLOW_EMPTY
```
    See Also:
    
    Constant Field Values
  - DEFAULT_EMPTY_IS_LOOPBACK
```
public static final boolean DEFAULT_EMPTY_IS_LOOPBACK
```
    See Also:
    
    Constant Field Values
  - DEFAULT_ALLOW_PREFIX
```
public static final boolean DEFAULT_ALLOW_PREFIX
```
    See Also:
    
    Constant Field Values
  - DEFAULT_ALLOW_MASK
```
public static final boolean DEFAULT_ALLOW_MASK
```
    See Also:
    
    Constant Field Values
  - DEFAULT_ALLOW_PREFIX_ONLY
```
public static final boolean DEFAULT_ALLOW_PREFIX_ONLY
```
    See Also:
    
    Constant Field Values
  - DEFAULT_ALLOW_ALL
```
public static final boolean DEFAULT_ALLOW_ALL
```
    See Also:
    
    Constant Field Values
  - DEFAULT_ALLOW_WILDCARDED_SEPARATOR
```
public static final boolean DEFAULT_ALLOW_WILDCARDED_SEPARATOR
```
    See Also:
    
    Constant Field Values
  - DEFAULT_ALLOW_PREFIX_BEYOND_ADDRESS_SIZE
```
public static final boolean DEFAULT_ALLOW_PREFIX_BEYOND_ADDRESS_SIZE
```
    See Also:
    
    Constant Field Values
  - DEFAULT_RANGE_OPTIONS
```
public static final IPAddressStringParameters.RangeParameters DEFAULT_RANGE_OPTIONS
```
  - allowEmpty
```
public final boolean allowEmpty
```
    Allows zero-length IPAddressStrings like ""
    
    See Also:
    
    emptyIsLoopback, DEFAULT_ALLOW_EMPTY
  - allowPrefixOnly
```
public final boolean allowPrefixOnly
```
    Allows addresses like /64 which are only prefix lenths. Such addresses are interpreted as the network mask for the given prefix length.
    
    See Also:
    
    DEFAULT_ALLOW_PREFIX_ONLY
  - allowAll
```
public final boolean allowAll
```
    Allows the all-encompassing address *, which represents the network of all IPv4 and IPv6 addresses
    
    See Also:
    
    DEFAULT_ALLOW_ALL
  - emptyIsLoopback
```
public final boolean emptyIsLoopback
```
    Whether the zero-length address is interpreted as the loopback.
    
    See Also:
    
    allowEmpty, DEFAULT_EMPTY_IS_LOOPBACK
  - allowPrefix
```
public final boolean allowPrefix
```
    Allows addresses with prefix length like 1.2.0.0/16 Such as an address is interpreted as a subnet. 1.2.0.0/16 is the subnet of addresses with network prefix 1.2
    
    See Also:
    
    DEFAULT_ALLOW_PREFIX
  - allowMask
```
public final 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
    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.
    
    See Also:
    
    allowPrefix, DEFAULT_ALLOW_MASK
- Constructor Detail
  - IPAddressStringParameters
```
public IPAddressStringParameters(boolean allowEmpty,
                                 boolean allowAll,
                                 boolean emptyIsLoopback,
                                 boolean allowPrefix,
                                 boolean allowMask,
                                 boolean allowPrefixOnly,
                                 IPv4AddressStringParameters ipv4Options,
                                 IPv6AddressStringParameters ipv6Options)
```
- Method Detail
  - toBuilder
```
public IPAddressStringParameters.Builder toBuilder()
```
  - toBuilder
```
public IPAddressStringParameters.Builder toBuilder(boolean isMixed)
```
  - getIPv6Parameters
```
public IPv6AddressStringParameters getIPv6Parameters()
```
  - getIPv4Parameters
```
public IPv4AddressStringParameters getIPv4Parameters()
```
  - clone
```
public IPAddressStringParameters clone()
```
    Overrides:
    
    clone in class java.lang.Object
  - compareTo
```
public int compareTo(IPAddressStringParameters o)
```
    Specified by:
    
    compareTo in interface java.lang.Comparable<IPAddressStringParameters>
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object

Methods inherited from class java.lang.Object

DEFAULT_ALLOW_LEADING_ZEROS

DEFAULT_ALLOW_PREFIX_LENGTH_LEADING_ZEROS

DEFAULT_ALLOW_UNLIMITED_LEADING_ZEROS

DEFAULT_ALLOW_EMPTY

DEFAULT_EMPTY_IS_LOOPBACK

DEFAULT_ALLOW_PREFIX

DEFAULT_ALLOW_MASK

DEFAULT_ALLOW_PREFIX_ONLY

DEFAULT_ALLOW_ALL

DEFAULT_ALLOW_WILDCARDED_SEPARATOR

DEFAULT_ALLOW_PREFIX_BEYOND_ADDRESS_SIZE

DEFAULT_RANGE_OPTIONS

allowEmpty

allowPrefixOnly

allowAll

emptyIsLoopback

allowPrefix

allowMask

IPAddressStringParameters

toBuilder

toBuilder

getIPv6Parameters

getIPv4Parameters

clone

compareTo

equals

hashCode