java.lang.Object
- org.apache.commons.net.util.SubnetUtils

```
public class SubnetUtils
extends java.lang.Object
```
Performs subnet calculations given a network address and a subnet mask.

Since:

2.0

See Also:

Classless Inter-Domain Routing (CIDR): an Address Assignment and Aggregation Strategy, SubnetUtils6

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`private static class`	`SubnetUtils.SubnetAddressStringIterable`	Allows an object to be the target of the "for-each loop" statement for a SubnetInfo.
`private static class`	`SubnetUtils.SubnetAddressStringIterator`	Iterates over a SubnetInfo.
`class`	`SubnetUtils.SubnetInfo`	Contains subnet summary information.

Field Summary

Fields
Modifier and Type	Field	Description
`private int`	`address`
`private static java.util.regex.Pattern`	`ADDRESS_PATTERN`
`private int`	`broadcast`
`private static java.util.regex.Pattern`	`CIDR_PATTERN`
`private boolean`	`inclusiveHostCount`	Whether the broadcast/network address are included in host count
`private static java.lang.String`	`IP_ADDRESS`
`private static int`	`NBITS`
`private int`	`netmask`
`private int`	`network`
`private static java.lang.String`	`PARSE_FAIL`
`private static java.lang.String`	`SLASH_FORMAT`

Constructor Summary

Constructors
Constructor	Description
`SubnetUtils(java.lang.String cidrNotation)`	Constructs an instance from a CIDR-notation string, e.g.
`SubnetUtils(java.lang.String address, java.lang.String mask)`	Constructs an instance from a dotted decimal address and a dotted decimal mask.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`private static java.lang.String`	`format(int[] octets)`	Converts a 4-element array into dotted decimal format.
`SubnetUtils.SubnetInfo`	`getInfo()`	Gets a `SubnetUtils.SubnetInfo` instance that contains subnet-specific statistics
`SubnetUtils`	`getNext()`	Gets the next subnet for this instance.
`SubnetUtils`	`getPrevious()`	Gets the previous subnet for this instance.
`boolean`	`isInclusiveHostCount()`	Tests if the return value of `SubnetUtils.SubnetInfo.getAddressCount()` includes the network and broadcast addresses.
`private static int`	`matchAddress(java.util.regex.Matcher matcher)`	Extracts the components of a dotted decimal address and pack into an integer using a regex match
`private static int`	`rangeCheck(int value, int begin, int end)`	Checks integer boundaries.
`void`	`setInclusiveHostCount(boolean inclusiveHostCount)`	Sets to `true` if you want the return value of `SubnetUtils.SubnetInfo.getAddressCount()` to include the network and broadcast addresses.
`private static int[]`	`toArray4(int val)`	Converts a packed integer address into a 4-element array
`private static int`	`toInteger(java.lang.String address)`	Converts a dotted decimal format address to a packed integer format.
`java.lang.String`	`toString()`	Converts this instance to a debug String.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - IP_ADDRESS
```
private static final java.lang.String IP_ADDRESS
```
    See Also:
    
    Constant Field Values
  - SLASH_FORMAT
```
private static final java.lang.String SLASH_FORMAT
```
    See Also:
    
    Constant Field Values
  - ADDRESS_PATTERN
```
private static final java.util.regex.Pattern ADDRESS_PATTERN
```
  - CIDR_PATTERN
```
private static final java.util.regex.Pattern CIDR_PATTERN
```
  - NBITS
```
private static final int NBITS
```
    See Also:
    
    Constant Field Values
  - PARSE_FAIL
```
private static final java.lang.String PARSE_FAIL
```
    See Also:
    
    Constant Field Values
  - address
```
private final int address
```
  - broadcast
```
private final int broadcast
```
  - inclusiveHostCount
```
private boolean inclusiveHostCount
```
    Whether the broadcast/network address are included in host count
  - netmask
```
private final int netmask
```
  - network
```
private final int network
```
- Constructor Detail
  - SubnetUtils
```
public SubnetUtils(java.lang.String cidrNotation)
```
    Constructs an instance from a CIDR-notation string, e.g. "192.168.0.1/16"
    
    Parameters:
    
    cidrNotation - A CIDR-notation string, e.g. "192.168.0.1/16"
    
    Throws:
    
    java.lang.IllegalArgumentException - if the parameter is invalid, i.e. does not match n.n.n.n/m where n=1-3 decimal digits, m = 1-2 decimal digits in range 0-32
  - SubnetUtils
```
public SubnetUtils(java.lang.String address,
                   java.lang.String mask)
```
    Constructs an instance from a dotted decimal address and a dotted decimal mask.
    
    Parameters:
    
    address - An IP address, e.g. "192.168.0.1"
    
    mask - A dotted decimal netmask e.g. "255.255.0.0"
    
    Throws:
    
    java.lang.IllegalArgumentException - if the address or mask is invalid, i.e. does not match n.n.n.n where n=1-3 decimal digits and the mask is not all zeros
- Method Detail
  - format
```
private static java.lang.String format(int[] octets)
```
    Converts a 4-element array into dotted decimal format.
  - matchAddress
```
private static int matchAddress(java.util.regex.Matcher matcher)
```
    Extracts the components of a dotted decimal address and pack into an integer using a regex match
  - rangeCheck
```
private static int rangeCheck(int value,
                              int begin,
                              int end)
```
    Checks integer boundaries. Checks if a value x is in the range [begin,end]. Returns x if it is in range, throws an exception otherwise.
  - toArray4
```
private static int[] toArray4(int val)
```
    Converts a packed integer address into a 4-element array
  - toInteger
```
private static int toInteger(java.lang.String address)
```
    Converts a dotted decimal format address to a packed integer format.
  - getInfo
```
public final SubnetUtils.SubnetInfo getInfo()
```
    Gets a SubnetUtils.SubnetInfo instance that contains subnet-specific statistics
    
    Returns:
    
    new instance
  - getNext
```
public SubnetUtils getNext()
```
    Gets the next subnet for this instance.
    
    Returns:
    
    the next subnet for this instance.
  - getPrevious
```
public SubnetUtils getPrevious()
```
    Gets the previous subnet for this instance.
    
    Returns:
    
    the next previous for this instance.
  - isInclusiveHostCount
```
public boolean isInclusiveHostCount()
```
    Tests if the return value of SubnetUtils.SubnetInfo.getAddressCount() includes the network and broadcast addresses.
    
    Returns:
    
    true if the host count includes the network and broadcast addresses
    
    Since:
    
    2.2
  - setInclusiveHostCount
```
public void setInclusiveHostCount(boolean inclusiveHostCount)
```
    Sets to true if you want the return value of SubnetUtils.SubnetInfo.getAddressCount() to include the network and broadcast addresses. This also applies to SubnetUtils.SubnetInfo.isInRange(int)
    
    Parameters:
    
    inclusiveHostCount - true if network and broadcast addresses are to be included
    
    Since:
    
    2.2
  - toString
```
public java.lang.String toString()
```
    Converts this instance to a debug String.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    this instance to a debug String.
    
    Since:
    
    3.11.0

Class SubnetUtils

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

IP_ADDRESS

SLASH_FORMAT

ADDRESS_PATTERN

CIDR_PATTERN

NBITS

PARSE_FAIL

address

broadcast

inclusiveHostCount

netmask

network

Constructor Detail

SubnetUtils

SubnetUtils

Method Detail

format

matchAddress

rangeCheck

toArray4

toInteger

getInfo

getNext

getPrevious

isInclusiveHostCount

setInclusiveHostCount

toString