Class SubnetUtils
- java.lang.Object
-
- org.jenkinsci.remoting.org.apache.commons.net.util.SubnetUtils
-
@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class) public class SubnetUtils extends Object
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 class
SubnetUtils.SubnetInfo
Convenience container for subnet summary information.
-
Constructor Summary
Constructors Constructor Description SubnetUtils(String cidrNotation)
Constructs an instance from a CIDR-notation string, e.g.SubnetUtils(String address, String mask)
Constructs an instance from a dotted decimal address and a dotted decimal mask.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SubnetUtils.SubnetInfo
getInfo()
Gets aSubnetUtils.SubnetInfo
instance that contains subnet-specific statisticsSubnetUtils
getNext()
SubnetUtils
getPrevious()
boolean
isInclusiveHostCount()
Tests if the return value ofSubnetUtils.SubnetInfo.getAddressCount()
includes the network and broadcast addresses.void
setInclusiveHostCount(boolean inclusiveHostCount)
Sets totrue
if you want the return value ofSubnetUtils.SubnetInfo.getAddressCount()
to include the network and broadcast addresses.
-
-
-
Constructor Detail
-
SubnetUtils
public SubnetUtils(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:
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(String address, 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:
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
-
getInfo
public final SubnetUtils.SubnetInfo getInfo()
Gets aSubnetUtils.SubnetInfo
instance that contains subnet-specific statistics- Returns:
- new instance
-
getNext
public SubnetUtils getNext()
-
getPrevious
public SubnetUtils getPrevious()
-
isInclusiveHostCount
public boolean isInclusiveHostCount()
Tests if the return value ofSubnetUtils.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 totrue
if you want the return value ofSubnetUtils.SubnetInfo.getAddressCount()
to include the network and broadcast addresses. This also applies toSubnetUtils.SubnetInfo.isInRange(int)
- Parameters:
inclusiveHostCount
- true if network and broadcast addresses are to be included- Since:
- 2.2
-
-