Package org.apache.commons.net.util
Class SubnetUtils
- java.lang.Object
-
- org.apache.commons.net.util.SubnetUtils
-
public class SubnetUtils extends java.lang.ObjectA class that performs some subnet calculations given a network address and a subnet mask.- Since:
- 2.0
- See Also:
- "http://www.faqs.org/rfcs/rfc1519.html"
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description classSubnetUtils.SubnetInfoConvenience container for subnet summary information.
-
Constructor Summary
Constructors Constructor Description SubnetUtils(java.lang.String cidrNotation)Constructor that takes a CIDR-notation string, e.g.SubnetUtils(java.lang.String address, java.lang.String mask)Constructor that takes a dotted decimal address and a dotted decimal mask.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SubnetUtils.SubnetInfogetInfo()Return aSubnetUtils.SubnetInfoinstance that contains subnet-specific statisticsbooleanisInclusiveHostCount()Returnstrueif the return value ofSubnetUtils.SubnetInfo.getAddressCount()includes the network and broadcast addresses.voidsetInclusiveHostCount(boolean inclusiveHostCount)Set totrueif you want the return value ofSubnetUtils.SubnetInfo.getAddressCount()to include the network and broadcast addresses.
-
-
-
Constructor Detail
-
SubnetUtils
public SubnetUtils(java.lang.String cidrNotation)
Constructor that takes 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-3 decimal digits in range 1-32
-
SubnetUtils
public SubnetUtils(java.lang.String address, java.lang.String mask)Constructor that takes 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
-
isInclusiveHostCount
public boolean isInclusiveHostCount()
Returnstrueif the return value ofSubnetUtils.SubnetInfo.getAddressCount()includes the network and broadcast addresses.- Returns:
- true if the hostcount includes the network and broadcast addresses
- Since:
- 2.2
-
setInclusiveHostCount
public void setInclusiveHostCount(boolean inclusiveHostCount)
Set totrueif you want the return value ofSubnetUtils.SubnetInfo.getAddressCount()to include the network and broadcast addresses.- Parameters:
inclusiveHostCount- true if network and broadcast addresses are to be included- Since:
- 2.2
-
getInfo
public final SubnetUtils.SubnetInfo getInfo()
Return aSubnetUtils.SubnetInfoinstance that contains subnet-specific statistics- Returns:
- new instance
-
-