Package org.apache.commons.net.util
Class SubnetUtils.SubnetInfo
- java.lang.Object
-
- org.apache.commons.net.util.SubnetUtils.SubnetInfo
-
- Enclosing class:
- SubnetUtils
public final class SubnetUtils.SubnetInfo extends java.lang.Object
Convenience container for subnet summary information.
-
-
Field Summary
Fields Modifier and Type Field Description private static long
UNSIGNED_INT_MASK
Mask to convert unsigned int to a long (i.e.
-
Constructor Summary
Constructors Modifier Constructor Description private
SubnetInfo()
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description int
asInteger(java.lang.String address)
private long
broadcastLong()
private java.lang.String
format(int[] octets)
Converts a 4-element array into dotted decimal format.java.lang.String
getAddress()
int
getAddressCount()
Deprecated.(3.4) usegetAddressCountLong()
insteadlong
getAddressCountLong()
Gets the count of available addresses.java.lang.String[]
getAllAddresses()
java.lang.String
getBroadcastAddress()
java.lang.String
getCidrSignature()
java.lang.String
getHighAddress()
Gets the high address as a dotted IP address.java.lang.String
getLowAddress()
Gets the low address as a dotted IP address.java.lang.String
getNetmask()
java.lang.String
getNetworkAddress()
java.lang.String
getNextAddress()
java.lang.String
getPreviousAddress()
private int
high()
boolean
isInRange(int address)
Tests if the parameteraddress
is in the range of usable endpoint addresses for this subnet.boolean
isInRange(java.lang.String address)
Tests if the parameteraddress
is in the range of usable endpoint addresses for this subnet.private int
low()
private long
networkLong()
Long versions of the values (as unsigned int) which are more suitable for range checking.private int[]
toArray(int val)
Converts a packed integer address into a 4-element arrayjava.lang.String
toString()
-
-
-
Field Detail
-
UNSIGNED_INT_MASK
private static final long UNSIGNED_INT_MASK
Mask to convert unsigned int to a long (i.e. keep 32 bits).- See Also:
- Constant Field Values
-
-
Method Detail
-
asInteger
public int asInteger(java.lang.String address)
-
broadcastLong
private long broadcastLong()
-
format
private java.lang.String format(int[] octets)
Converts a 4-element array into dotted decimal format.
-
getAddress
public java.lang.String getAddress()
-
getAddressCount
@Deprecated public int getAddressCount()
Deprecated.(3.4) usegetAddressCountLong()
insteadGets the count of available addresses. Will be zero for CIDR/31 and CIDR/32 if the inclusive flag is false.- Returns:
- the count of addresses, may be zero.
- Throws:
java.lang.RuntimeException
- if the correct count is greater thanInteger.MAX_VALUE
-
getAddressCountLong
public long getAddressCountLong()
Gets the count of available addresses. Will be zero for CIDR/31 and CIDR/32 if the inclusive flag is false.- Returns:
- the count of addresses, may be zero.
- Since:
- 3.4
-
getAllAddresses
public java.lang.String[] getAllAddresses()
-
getBroadcastAddress
public java.lang.String getBroadcastAddress()
-
getCidrSignature
public java.lang.String getCidrSignature()
-
getHighAddress
public java.lang.String getHighAddress()
Gets the high address as a dotted IP address. Will be zero for CIDR/31 and CIDR/32 if the inclusive flag is false.- Returns:
- the IP address in dotted format, may be "0.0.0.0" if there is no valid address
-
getLowAddress
public java.lang.String getLowAddress()
Gets the low address as a dotted IP address. Will be zero for CIDR/31 and CIDR/32 if the inclusive flag is false.- Returns:
- the IP address in dotted format, may be "0.0.0.0" if there is no valid address
-
getNetmask
public java.lang.String getNetmask()
-
getNetworkAddress
public java.lang.String getNetworkAddress()
-
getNextAddress
public java.lang.String getNextAddress()
-
getPreviousAddress
public java.lang.String getPreviousAddress()
-
high
private int high()
-
isInRange
public boolean isInRange(int address)
Tests if the parameteraddress
is in the range of usable endpoint addresses for this subnet. This excludes the network and broadcast addresses by default. UseSubnetUtils.setInclusiveHostCount(boolean)
to change this.- Parameters:
address
- the address to check- Returns:
- true if it is in range
- Since:
- 3.4 (made public)
-
isInRange
public boolean isInRange(java.lang.String address)
Tests if the parameteraddress
is in the range of usable endpoint addresses for this subnet. This excludes the network and broadcast addresses. UseSubnetUtils.setInclusiveHostCount(boolean)
to change this.- Parameters:
address
- A dot-delimited IPv4 address, e.g. "192.168.0.1"- Returns:
- True if in range, false otherwise
-
low
private int low()
-
networkLong
private long networkLong()
Long versions of the values (as unsigned int) which are more suitable for range checking.
-
toArray
private int[] toArray(int val)
Converts a packed integer address into a 4-element array
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
- Since:
- 2.2
-
-