InetSubnet (stdlib 7.0.1 API)

java.lang.Object
- com.peterphi.std.types.InetSubnet

```
public class InetSubnet
extends java.lang.Object
```
Represents an IPv4 network subnet (a combination of an IP address and a prefix. For example, 193.61.123.0/24 represents 193.61.123.1 to 193.61.123.254)
The data stored by this class is similar to the InterfaceAddress class, however that class is non-constructable and does not include helper methods to determine subnet membership

Field Summary

Fields
Modifier and Type	Field and Description
`static InetSubnet`	`IPV4_ADDRESS_SPACE` The entire IPv4 address space (including restricted/reserved/private IPs) This is the subnet 0.0.0.0/0
`java.net.InetAddress`	`network`
`int`	`prefix`

Constructor Summary

Constructors
Constructor and Description
`InetSubnet(java.net.InetAddress network, java.net.InetAddress netmask)` Produces a subnet based on a network IP and a netmask.
`InetSubnet(java.net.InetAddress network, int prefix)` Produces a subnet based on a network IP and a prefix
`InetSubnet(java.net.InterfaceAddress addr)`
`InetSubnet(int ip, int prefix)` Construct a subnet based on
`InetSubnet(java.lang.String cidr)` Constructs an inet subnet from CIDR representation (`x.x.x.x/prefix`)
`InetSubnet(java.lang.String ip, int prefix)`

Method Summary

Methods
Modifier and Type	Method and Description
`InetSubnet`	`canonicalise()` Produces a canonical representation of this subnet; the canonical form has the network ip address properly masked (eg.
`boolean`	`equals(java.lang.Object o)`
`java.net.InetAddress`	`getBroadcast()` Returns the broadcast address of this subnet
`java.net.InetAddress`	`getHostMax()` Gets the last host in this subnet
`java.net.InetAddress`	`getHostMin()` Gets the first host in this subnet
`int`	`getHosts()` Returns the number of hosts in this subnet
`java.net.InetAddress`	`getIP()` Returns the IP address represented by this subnet; when in its canonical form, `getIP()` will return the same as `getNetwork()`
`java.net.InetAddress`	`getNetmask()` Retrieves the prefix as a netmask (eg.
`java.net.InetAddress`	`getNetwork()` Returns the InetAddress representing the network (fully masked by the prefix); this is the IP address with the last `prefix` bits masked to zero
`int`	`getPrefix()` Returns the prefix length (0 to 32 for an IPv4 subnet) The larger the prefix the larger the block if IP addresses represented by this subnet
`java.net.InetAddress`	`getWildcardMask()` Retrieves the wildcard mask for the netmask of this subnet
`int`	`hashCode()`
`boolean`	`isCanonical()` Determines whether this InetSubnet is currently in its canonical form
`boolean`	`isMember(java.net.InetAddress ip)` Determines whether a given IP is a member of this subnet
`boolean`	`isMember(int ip)` Determines whether a given IP, in numeric representation (as returned by `aton()`) is a member of this subnet This is the fastest way to determine subnet membership
`boolean`	`isMember(java.lang.String ip)` Determines whether a given IP, given as an IPv4 address in its string representation (x.x.x.x) is a member of this subnet
`boolean`	`member(java.net.InetAddress ip)` Deprecated. use isMember instead
`boolean`	`member(int ip)` Deprecated. use isMember instead
`boolean`	`member(java.lang.String ip)` Deprecated. use isMember instead
`java.lang.String`	`toString()` Emits this subnet in CIDR notation using the prefix (eg.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - IPV4_ADDRESS_SPACE
```
public static final InetSubnet IPV4_ADDRESS_SPACE
```
    The entire IPv4 address space (including restricted/reserved/private IPs)
    This is the subnet 0.0.0.0/0
  - network
```
public final java.net.InetAddress network
```
  - prefix
```
public final int prefix
```
- Constructor Detail
  - InetSubnet
```
public InetSubnet(java.net.InterfaceAddress addr)
```
  - InetSubnet
```
public InetSubnet(java.lang.String cidr)
```
    Constructs an inet subnet from CIDR representation (x.x.x.x/prefix)
    
    Parameters:
    tostring -
  - InetSubnet
```
public InetSubnet(java.lang.String ip,
          int prefix)
```
    Parameters:
    ip -
    prefix -
    
    Throws:
    
    java.lang.IllegalArgumentException - if the IP address cannot be parsed
  - InetSubnet
```
public InetSubnet(int ip,
          int prefix)
```
    Construct a subnet based on
    
    Parameters:
    ip -
    prefix -
  - InetSubnet
```
public InetSubnet(java.net.InetAddress network,
          int prefix)
```
    Produces a subnet based on a network IP and a prefix
    
    Parameters:
    network -
    prefix -
  - InetSubnet
```
public InetSubnet(java.net.InetAddress network,
          java.net.InetAddress netmask)
```
    Produces a subnet based on a network IP and a netmask. The internal representation always uses the prefix style
    
    Parameters:
    network -
    netmask -
- Method Detail
  - toString
```
public java.lang.String toString()
```
    Emits this subnet in CIDR notation using the prefix (eg. x.x.x.x/prefix)
    
    Overrides:
    
    toString in class java.lang.Object
    
    See Also:
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object
  - getIP
```
public java.net.InetAddress getIP()
```
    Returns the IP address represented by this subnet; when in its canonical form, getIP() will return the same as getNetwork()
    
    Returns:
    The IP address represented by this subnet; this may be different from the network InetAddress when the InetSubnet isn't canonicalised
  - getNetwork
```
public java.net.InetAddress getNetwork()
```
    Returns the InetAddress representing the network (fully masked by the prefix); this is the IP address with the last prefix bits masked to zero
    
    Returns:
  - getPrefix
```
public int getPrefix()
```
    Returns the prefix length (0 to 32 for an IPv4 subnet)
    The larger the prefix the larger the block if IP addresses represented by this subnet
    
    Returns:
  - getNetmask
```
public java.net.InetAddress getNetmask()
```
    Retrieves the prefix as a netmask (eg. a prefix of 24 becomes 255.255.255.0)
    
    Returns:
  - canonicalise
```
public InetSubnet canonicalise()
```
    Produces a canonical representation of this subnet; the canonical form has the network ip address properly masked (eg. 10.0.0.3/31 and 10.0.0.2/31 both canonicalise to 10.0.0.2/31)
    
    Returns:
  - isCanonical
```
public boolean isCanonical()
```
    Determines whether this InetSubnet is currently in its canonical form
    
    Returns:
  - isMember
```
public boolean isMember(int ip)
```
    Determines whether a given IP, in numeric representation (as returned by aton()) is a member of this subnet
    This is the fastest way to determine subnet membership
    
    Parameters:
    ip -
    
    Returns:
  - isMember
```
public boolean isMember(java.lang.String ip)
```
    Determines whether a given IP, given as an IPv4 address in its string representation (x.x.x.x) is a member of this subnet
    
    Parameters:
    ip -
    
    Returns:
    
    Throws:
    
    java.lang.IllegalArgumentException - if the IP cannot be parsed
  - isMember
```
public boolean isMember(java.net.InetAddress ip)
```
    Determines whether a given IP is a member of this subnet
    
    Parameters:
    ip -
    
    Returns:
  - member
```
@Deprecated
public boolean member(int ip)
```
    Deprecated. use isMember instead
    
    Parameters:
    ip -
    
    Returns:
  - member
```
@Deprecated
public boolean member(java.lang.String ip)
```
    Deprecated. use isMember instead
    
    Parameters:
    ip -
    
    Returns:
  - member
```
@Deprecated
public boolean member(java.net.InetAddress ip)
```
    Deprecated. use isMember instead
    
    Parameters:
    ip -
    
    Returns:
  - getHosts
```
public int getHosts()
```
    Returns the number of hosts in this subnet
    
    Returns:
  - getHostMin
```
public java.net.InetAddress getHostMin()
```
    Gets the first host in this subnet
    
    Returns:
  - getHostMax
```
public java.net.InetAddress getHostMax()
```
    Gets the last host in this subnet
    
    Returns:
  - getBroadcast
```
public java.net.InetAddress getBroadcast()
```
    Returns the broadcast address of this subnet
    
    Returns:
  - getWildcardMask
```
public java.net.InetAddress getWildcardMask()
```
    Retrieves the wildcard mask for the netmask of this subnet
    
    Returns:
    the inversion of the netmask (eg. 255.255.255.0 becomes 0.0.0.255)

Class InetSubnet

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

IPV4_ADDRESS_SPACE

network

prefix

Constructor Detail

InetSubnet

InetSubnet

InetSubnet

InetSubnet

InetSubnet

InetSubnet

Method Detail

toString

hashCode

equals

getIP

getNetwork

getPrefix

getNetmask

canonicalise

isCanonical

isMember

isMember

isMember

member

member

member

getHosts

getHostMin

getHostMax

getBroadcast

getWildcardMask