Cidr (Apache Brooklyn)

java.lang.Object
- org.apache.brooklyn.util.net.Cidr

All Implemented Interfaces:

java.io.Serializable
```
public class Cidr
extends java.lang.Object
implements java.io.Serializable
```
represents a CIDR (classless inter-domain routing) token, i.e. 10.0.0.0/8 or 192.168.4.0/24

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static Cidr`	`_10`
`static Cidr`	`_127`
`static Cidr`	`_169_254`
`static Cidr`	`_172_16`
`static Cidr`	`_192_168`
`static Cidr`	`CLASS_A`
`static Cidr`	`CLASS_B`
`static Cidr`	`CLASS_C`
`static Cidr`	`LINK_LOCAL`
`static Cidr`	`LOOPBACK`
`static java.util.List<Cidr>`	`NON_PUBLIC_CIDRS`
`static java.util.List<Cidr>`	`PRIVATE_NETWORKS_RFC_1918`
`static Cidr`	`UNIVERSAL` 0.0.0.0/0 -- matches all addresses

Constructor Summary

Constructors
Constructor and Description
`Cidr(int... unsignedBytes)` allows creation as Cidr(192, 168) for 192.168.0.0/16; zero bits or ints included are significant, i.e.
`Cidr(int[] subnetBytes, int length)`
`Cidr(java.lang.String cidr)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`java.net.InetAddress`	`addressAtOffset(int offset)` taking the addresses in the CIDR in order, returns the one in the offset^th position (starting with the CIDR itself, even if final bits are 0)
`BitList`	`asBitList()` returns list of bits for the significant (length) bits of this CIDR
`Cidr`	`commonPrefix(Cidr other)`
`int`	`commonPrefixLength(Cidr other)` returns length of the prefix in common between the two cidrs
`boolean`	`contains(Cidr target)`
`boolean`	`equals(java.lang.Object obj)`
`int[]`	`getBytes()`
`static java.net.InetAddress`	`getInetAddressWithFixedName(byte[] ip)` Deprecated. use `Networking.getInetAddressWithFixedName(byte[])`
`int`	`getLength()`
`int`	`hashCode()`
`static boolean`	`isCanonical(java.lang.String cidr)` returns true iff this CIDR is well-formed and canonical, i.e.
`java.net.InetAddress`	`netmask()` returns the netmask for this cidr; e.g.
`Cidr`	`subnet(int... extraUnsignedBytes)`
`java.lang.String`	`toString()`

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

- Field Detail
  - UNIVERSAL
```
public static final Cidr UNIVERSAL
```
    0.0.0.0/0 -- matches all addresses
  - _10
```
public static final Cidr _10
```
  - _172_16
```
public static final Cidr _172_16
```
  - _192_168
```
public static final Cidr _192_168
```
  - CLASS_A
```
public static final Cidr CLASS_A
```
  - CLASS_B
```
public static final Cidr CLASS_B
```
  - CLASS_C
```
public static final Cidr CLASS_C
```
  - PRIVATE_NETWORKS_RFC_1918
```
public static final java.util.List<Cidr> PRIVATE_NETWORKS_RFC_1918
```
  - _169_254
```
public static final Cidr _169_254
```
  - LINK_LOCAL
```
public static final Cidr LINK_LOCAL
```
  - _127
```
public static final Cidr _127
```
  - LOOPBACK
```
public static final Cidr LOOPBACK
```
  - NON_PUBLIC_CIDRS
```
public static final java.util.List<Cidr> NON_PUBLIC_CIDRS
```
- Constructor Detail
  - Cidr
```
public Cidr(java.lang.String cidr)
```
  - Cidr
```
public Cidr(int... unsignedBytes)
```
    allows creation as Cidr(192, 168) for 192.168.0.0/16; zero bits or ints included are significant, i.e. Cidr(10, 0) gives 10.0.0.0/16
  - Cidr
```
public Cidr(int[] subnetBytes,
            int length)
```
- Method Detail
  - isCanonical
```
public static boolean isCanonical(java.lang.String cidr)
```
    returns true iff this CIDR is well-formed and canonical, i.e. 4 dot-separated bytes followed by a slash and a length, where length is <= 32, and the preceding 4 bytes don't include any 1 bits beyond the indicated length; e.g. 10.0.0.0/8 -- but not 10.0.0.1/8 or 10.../8 (although the latter ones are accepted by the constructor and converted to the canonical CIDR)
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - getBytes
```
public int[] getBytes()
```
  - getLength
```
public int getLength()
```
  - subnet
```
public Cidr subnet(int... extraUnsignedBytes)
```
  - netmask
```
public java.net.InetAddress netmask()
```
    returns the netmask for this cidr; e.g. for a /24 cidr returns 255.255.255.0
  - addressAtOffset
```
public java.net.InetAddress addressAtOffset(int offset)
```
    taking the addresses in the CIDR in order, returns the one in the offset^th position (starting with the CIDR itself, even if final bits are 0)
  - commonPrefixLength
```
public int commonPrefixLength(Cidr other)
```
    returns length of the prefix in common between the two cidrs
  - commonPrefix
```
public Cidr commonPrefix(Cidr other)
```
  - asBitList
```
public BitList asBitList()
```
    returns list of bits for the significant (length) bits of this CIDR
  - contains
```
public boolean contains(Cidr target)
```
  - getInetAddressWithFixedName
```
@Deprecated
public static java.net.InetAddress getInetAddressWithFixedName(byte[] ip)
```
    Deprecated. use Networking.getInetAddressWithFixedName(byte[])

Class Cidr

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

UNIVERSAL

_10

_172_16

_192_168

CLASS_A

CLASS_B

CLASS_C

PRIVATE_NETWORKS_RFC_1918

_169_254

LINK_LOCAL

_127

LOOPBACK

NON_PUBLIC_CIDRS

Constructor Detail

Cidr

Cidr

Cidr

Method Detail

isCanonical

hashCode

equals

toString

getBytes

getLength

subnet

netmask

addressAtOffset

commonPrefixLength

commonPrefix

asBitList

contains

getInetAddressWithFixedName