Modifier and Type	Class and Description
public class	SubnetUtils.SubnetInfo Convenience container for subnet summary information.

Modifier and Type	Field and Description
private int	address
private static final Pattern	addressPattern
private int	broadcast
private static final Pattern	cidrPattern
private boolean	inclusiveHostCount Whether the broadcast/network address are included in host count
private static final String	IP_ADDRESS
private static final int	NBITS
private int	netmask
private int	network
private static final String	SLASH_FORMAT

Access	Constructor and Description
public	SubnetUtils(String A CIDR-notation string, e.g. "192.168.0.1/16" cidrNotation) Constructor that takes a CIDR-notation string, e.g. "192.168.0.1/16"
public	SubnetUtils(String An IP address, e.g. "192.168.0.1" address, String A dotted decimal netmask e.g. "255.255.0.0" mask) Constructor that takes a dotted decimal address and a dotted decimal mask.

Method Summary

Modifier and Type	Method and Description
private void	calculate(String mask)
private String	format(int[] octets)
public final SubnetUtils.SubnetInfo	Returns: new instance getInfo() Return a `SubnetInfo` instance that contains subnet-specific statistics
public boolean	isInclusiveHostCount() Returns `true` if the return value of `SubnetInfo#getAddressCount()` includes the network address and broadcast addresses.
private int	matchAddress(Matcher matcher)
pack-priv int	pop(int x)
private int	rangeCheck(int value, int begin, int end)
public void	setInclusiveHostCount(boolean inclusiveHostCount) Set to `true` if you want the return value of `SubnetInfo#getAddressCount()` to include the network and broadcast addresses.
private int[]	toArray(int val)
private String	toCidrNotation(String addr, String mask)
private int	toInteger(String address)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

address	back to summary
private int address

addressPattern	back to summary
private static final Pattern addressPattern

broadcast	back to summary
private int broadcast

cidrPattern	back to summary
private static final Pattern cidrPattern

inclusiveHostCount	back to summary
private boolean inclusiveHostCount Whether the broadcast/network address are included in host count

IP_ADDRESS	back to summary
private static final String IP_ADDRESS

NBITS	back to summary
private static final int NBITS

netmask	back to summary
private int netmask

network	back to summary
private int network

SLASH_FORMAT	back to summary
private static final String SLASH_FORMAT

Constructor Detail

SubnetUtils	back to summary
public SubnetUtils(String cidrNotation) Constructor that takes a CIDR-notation string, e.g. "192.168.0.1/16" Parameters cidrNotation:String A CIDR-notation string, e.g. "192.168.0.1/16" Exceptions 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

back to summary

public SubnetUtils(String cidrNotation)

Constructor that takes a CIDR-notation string, e.g. "192.168.0.1/16"

Parameters

cidrNotation:String: A CIDR-notation string, e.g. "192.168.0.1/16"

Exceptions

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	back to summary
public SubnetUtils(String address, String mask) Constructor that takes a dotted decimal address and a dotted decimal mask. Parameters address:String An IP address, e.g. "192.168.0.1" mask:String A dotted decimal netmask e.g. "255.255.0.0" Exceptions 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

SubnetUtils

back to summary

public SubnetUtils(String address, String mask)

Constructor that takes a dotted decimal address and a dotted decimal mask.

Parameters

address:String: An IP address, e.g. "192.168.0.1"
mask:String: A dotted decimal netmask e.g. "255.255.0.0"

Exceptions

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

calculate	back to summary
private void calculate(String mask)

format	back to summary
private String format(int[] octets)

getInfo back to summary

getInfo	back to summary
public final SubnetUtils.SubnetInfo getInfo() Return a `SubnetInfo` instance that contains subnet-specific statistics Returns:SubnetUtils.SubnetInfo new instance

public final SubnetUtils.SubnetInfo getInfo()

Return a SubnetInfo instance that contains subnet-specific statistics

Returns:SubnetUtils.SubnetInfo: new instance

isInclusiveHostCount back to summary

isInclusiveHostCount	back to summary
public boolean isInclusiveHostCount() Returns `true` if the return value of `SubnetInfo#getAddressCount()` includes the network address and broadcast addresses. Since 2.2

public boolean isInclusiveHostCount()

Returns true if the return value of SubnetInfo#getAddressCount() includes the network address and broadcast addresses.

Since: 2.2

matchAddress	back to summary
private int matchAddress(Matcher matcher)

pop	back to summary
pack-priv int pop(int x)

rangeCheck	back to summary
private int rangeCheck(int value, int begin, int end)

setInclusiveHostCount back to summary

setInclusiveHostCount	back to summary
public void setInclusiveHostCount(boolean inclusiveHostCount) Set to `true` if you want the return value of `SubnetInfo#getAddressCount()` to include the network and broadcast addresses. Since 2.2

public void setInclusiveHostCount(boolean inclusiveHostCount)

Set to true if you want the return value of SubnetInfo#getAddressCount() to include the network and broadcast addresses.

Since: 2.2

toArray	back to summary
private int[] toArray(int val)

toCidrNotation	back to summary
private String toCidrNotation(String addr, String mask)

toInteger	back to summary
private int toInteger(String address)

org.jruby.ext.socket back to summary

public final Class SubnetUtils.SubnetInfo

Class Inheritance

extends Object

java.lang.Object
org.jruby.ext.socket.SubnetUtils.SubnetInfo

Convenience container for subnet summary information.

Constructor Summary

Access	Constructor and Description
private	SubnetInfo()

Method Summary

Modifier and Type	Method and Description
private int	address()
public int	asInteger(String address)
private int	broadcast()
public String	getAddress()
public int	Returns: the count of addresses, may be zero. getAddressCount() Get the count of available addresses.
public String[]	getAllAddresses()
public String	getBroadcastAddress()
public String	getCidrSignature()
public String	Returns: the IP address in dotted format, may be "0.0.0.0" if there is no valid address getHighAddress() Return the high address as a dotted IP address.
public String	Returns: the IP address in dotted format, may be "0.0.0.0" if there is no valid address getLowAddress() Return the low address as a dotted IP address.
public String	getNetmask()
public String	getNetworkAddress()
private int	high()
public boolean	Returns: True if in range, false otherwise isInRange(String A dot-delimited IPv4 address, e.g. "192.168.0.1" address) Returns true if the parameter `address` is in the range of usable endpoint addresses for this subnet.
private boolean	isInRange(int address)
private int	low()
private int	netmask()
private int	network()
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Constructor Detail

SubnetInfo	back to summary
private SubnetInfo()

Method Detail

address	back to summary
private int address()

asInteger	back to summary
public int asInteger(String address)

broadcast	back to summary
private int broadcast()

getAddress	back to summary
public String getAddress()

getAddressCount	back to summary
public int getAddressCount() Get the count of available addresses. Will be zero for CIDR/31 and CIDR/32 if the inclusive flag is false. Returns:int the count of addresses, may be zero.

getAddressCount

back to summary

public int getAddressCount()

Get the count of available addresses. Will be zero for CIDR/31 and CIDR/32 if the inclusive flag is false.

Returns:int: the count of addresses, may be zero.

getAllAddresses	back to summary
public String[] getAllAddresses()

getBroadcastAddress	back to summary
public String getBroadcastAddress()

getCidrSignature	back to summary
public String getCidrSignature()

getHighAddress	back to summary
public String getHighAddress() Return the high address as a dotted IP address. Will be zero for CIDR/31 and CIDR/32 if the inclusive flag is false. Returns:String the IP address in dotted format, may be "0.0.0.0" if there is no valid address

getHighAddress

back to summary

public String getHighAddress()

Return the high address as a dotted IP address. Will be zero for CIDR/31 and CIDR/32 if the inclusive flag is false.

Returns:String: the IP address in dotted format, may be "0.0.0.0" if there is no valid address

getLowAddress	back to summary
public String getLowAddress() Return the low address as a dotted IP address. Will be zero for CIDR/31 and CIDR/32 if the inclusive flag is false. Returns:String the IP address in dotted format, may be "0.0.0.0" if there is no valid address

getLowAddress

back to summary

public String getLowAddress()

Return the low address as a dotted IP address. Will be zero for CIDR/31 and CIDR/32 if the inclusive flag is false.

Returns:String: the IP address in dotted format, may be "0.0.0.0" if there is no valid address

getNetmask	back to summary
public String getNetmask()

getNetworkAddress	back to summary
public String getNetworkAddress()

high	back to summary
private int high()

isInRange back to summary

isInRange	back to summary
public boolean isInRange(String address) Returns true if the parameter `address` is in the range of usable endpoint addresses for this subnet. This excludes the network and broadcast adresses. Parameters address:String A dot-delimited IPv4 address, e.g. "192.168.0.1" Returns:boolean True if in range, false otherwise

public boolean isInRange(String address)

Returns true if the parameter address is in the range of usable endpoint addresses for this subnet. This excludes the network and broadcast adresses.

Parameters

address:String: A dot-delimited IPv4 address, e.g. "192.168.0.1"

Returns:boolean

True if in range, false otherwise

isInRange	back to summary
private boolean isInRange(int address)

low	back to summary
private int low()

netmask	back to summary
private int netmask()

network	back to summary
private int network()

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override Since 2.2

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

Since

2.2

public Class SubnetUtils

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Class SubnetUtils.SubnetInfo

Constructor Summary

Method Summary

Constructor Detail

Method Detail