Package org.jruby.ext.socket
Class SubnetUtils
java.lang.Object
org.jruby.ext.socket.SubnetUtils
A class that performs some subnet calculations given a network address and a subnet mask.
- Since:
- 2.0 Extracted from Apache Commons Net Project.
- Author:
- [email protected]
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionfinal classConvenience container for subnet summary information. -
Constructor Summary
ConstructorsConstructorDescriptionSubnetUtils(String cidrNotation) Constructor that takes a CIDR-notation string, e.g.SubnetUtils(String address, String mask) Constructor that takes a dotted decimal address and a dotted decimal mask. -
Method Summary
Modifier and TypeMethodDescriptionfinal SubnetUtils.SubnetInfogetInfo()Return aSubnetUtils.SubnetInfoinstance that contains subnet-specific statisticsbooleanReturnstrueif the return value ofSubnetUtils.SubnetInfo.getAddressCount()includes the network address and broadcast addresses.voidsetInclusiveHostCount(boolean inclusiveHostCount) Set totrueif you want the return value ofSubnetUtils.SubnetInfo.getAddressCount()to include the network and broadcast addresses.
-
Constructor Details
-
SubnetUtils
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:
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
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:
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 Details
-
isInclusiveHostCount
public boolean isInclusiveHostCount()Returnstrueif the return value ofSubnetUtils.SubnetInfo.getAddressCount()includes the network address 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-- Since:
- 2.2
-
getInfo
Return aSubnetUtils.SubnetInfoinstance that contains subnet-specific statistics- Returns:
- new instance
-