SmallRye Common 2.10.0 · io.smallrye.common.net.CidrAddress

Modifier and Type	Class and Description
pack-priv static class	CidrAddress.Ser

Modifier and Type	Field and Description
private Inet4Address	broadcast The cached broadcast address.
private final byte[]	cachedBytes The cached bytes of this address.
private int	hashCode The cached hash code of this object.
public static final CidrAddress	INET4_ANY_CIDR The CIDR address representing all IPv4 addresses.
public static final CidrAddress	INET6_ANY_CIDR The CIDR address representing all IPv6 addresses.
private final int	netmaskBits The number of netmask bits.
private final InetAddress	networkAddress The base network address of this CIDR address.
private static final long	serialVersionUID
private String	toString The cached to-string value of this object.

Access	Constructor and Description
private	CidrAddress(final InetAddress networkAddress, final int netmaskBits)

Method Summary

Modifier and Type	Method and Description
private static boolean	bitsMatch(byte[] address, byte[] test, int bits)
public int	Returns: `-1`, `0`, or `1` if this address is less than, equal to, or greater than the given address compareAddressBytesTo(final byte[] the bytes to compare to (must not be `null`) otherBytes, final int the netmask bits for the byte array otherNetmaskBits, final int the IPv6 scope ID, if any, or else zero scopeId) Compare the bytes of this address to the bytes in the given array.
public int	compareTo(final CidrAddress the object to be compared. other) Implements java.lang.Comparable.compareTo. Compares this object with the specified object for order.
public static CidrAddress	Returns: the CIDR address (not `null`) create(InetAddress the network address (must not be `null`) networkAddress, int the netmask bits (0-32 for IPv4, or 0-128 for IPv6) netmaskBits) Create a new CIDR address.
public static CidrAddress	Returns: the CIDR address (not `null`) create(byte[] the network address bytes (must not be `null`, must be 4 bytes for IPv4 or 16 bytes for IPv6) addressBytes, int the netmask bits (0-32 for IPv4, or 0-128 for IPv6) netmaskBits) Create a new CIDR address.
pack-priv static CidrAddress	create(byte[] addressBytes, int netmaskBits, boolean clone)
public boolean	Returns: `true` if this address is equal to the given object, or `false` if it is not equals(final Object the other address obj) Overrides java.lang.Object.equals. Returns `true` if this address is equal to the given object, or `false` if it is not.
public boolean	Returns: `true` if this address is equal to the given address, or `false` if it is not equals(final CidrAddress the other address obj) Returns `true` if this address is equal to the given address, or `false` if it is not.
public Inet4Address	Returns: the broadcast address for this CIDR block, or `null` if there is none getBroadcastAddress() Get the broadcast address for this CIDR block.
public int	Returns: the netmask bits getNetmaskBits() Get the netmask bits.
public InetAddress	Returns: the network address (not `null`) getNetworkAddress() Get the network address.
public int	Returns: the scope ID, or 0 if there is none or the address is an IPv4 address getScopeId() Get the match address scope ID (if it is an IPv6 address).
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
private static byte[]	maskBits0(byte[] address, int bits)
private static byte[]	maskBits1(byte[] address, int bits)
public boolean	Returns: `true` if the address matches, `false` otherwise matches(InetAddress the address to test address) Determine if this CIDR address matches the given address.
public boolean	Returns: `true` if the address bytes match, `false` otherwise matches(byte[] the address bytes to test bytes) Determine if this CIDR address matches the given address bytes.
public boolean	Returns: `true` if the address bytes match, `false` otherwise matches(byte[] the address bytes to test bytes, int the scope ID, or 0 to match no scope scopeId) Determine if this CIDR address matches the given address bytes.
public boolean	Returns: `true` if the address matches, `false` otherwise matches(Inet4Address the address to test address) Determine if this CIDR address matches the given address.
public boolean	Returns: `true` if the address matches, `false` otherwise matches(Inet6Address the address to test address) Determine if this CIDR address matches the given address.
public boolean	Returns: `true` if the given block is enclosed by this one, `false` otherwise matches(CidrAddress the address to test address) Determine if this CIDR address matches the given CIDR address.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
pack-priv Object	Returns: the serialization replacement for this object writeReplace() Returns the serialization replacement for this object.

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

broadcast	back to summary
private Inet4Address broadcast The cached broadcast address.

cachedBytes	back to summary
private final byte[] cachedBytes The cached bytes of this address.

hashCode	back to summary
private int hashCode The cached hash code of this object.

INET4_ANY_CIDR	back to summary
public static final CidrAddress INET4_ANY_CIDR The CIDR address representing all IPv4 addresses.

INET6_ANY_CIDR	back to summary
public static final CidrAddress INET6_ANY_CIDR The CIDR address representing all IPv6 addresses.

netmaskBits	back to summary
private final int netmaskBits The number of netmask bits.

networkAddress	back to summary
private final InetAddress networkAddress The base network address of this CIDR address.

serialVersionUID	back to summary
private static final long serialVersionUID

toString	back to summary
private String toString The cached to-string value of this object.

CidrAddress	back to summary
private CidrAddress(final InetAddress networkAddress, final int netmaskBits)

Method Detail

bitsMatch	back to summary
private static boolean bitsMatch(byte[] address, byte[] test, int bits)

compareAddressBytesTo back to summary

compareAddressBytesTo	back to summary
public int compareAddressBytesTo(final byte[] otherBytes, final int otherNetmaskBits, final int scopeId) Compare the bytes of this address to the bytes in the given array. Parameters otherBytes:byte[] the bytes to compare to (must not be `null`) otherNetmaskBits:int the netmask bits for the byte array scopeId:int the IPv6 scope ID, if any, or else zero Returns:int `-1`, `0`, or `1` if this address is less than, equal to, or greater than the given address

public int compareAddressBytesTo(final byte[] otherBytes, final int otherNetmaskBits, final int scopeId)

Compare the bytes of this address to the bytes in the given array.

Parameters

otherBytes:byte[]: the bytes to compare to (must not be null)
otherNetmaskBits:int: the netmask bits for the byte array
scopeId:int: the IPv6 scope ID, if any, or else zero

Returns:int

-1, 0, or 1 if this address is less than, equal to, or greater than the given address

compareTo back to summary

compareTo	back to summary
public int compareTo(final CidrAddress other) Implements java.lang.Comparable.compareTo. Doc from java.lang.Comparable.compareTo. Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object. The implementor must ensure `signum(x.compareTo(y)) == -signum(y.compareTo(x))` for all `x` and `y`. (This implies that `x.compareTo(y)` must throw an exception if and only if `y.compareTo(x)` throws an exception.) The implementor must also ensure that the relation is transitive: `(x.compareTo(y) > 0 && y.compareTo(z) > 0)` implies `x.compareTo(z) > 0`. Finally, the implementor must ensure that `x.compareTo(y)==0` implies that `signum(x.compareTo(z)) == signum(y.compareTo(z))`, for all `z`. Parameters other:CidrAddress the object to be compared. Returns:int a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

public int compareTo(final CidrAddress other)

Implements java.lang.Comparable.compareTo.

Doc from java.lang.Comparable.compareTo.

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

The implementor must ensure signum(x.compareTo(y)) == -signum(y.compareTo(x)) for all x and y. (This implies that x.compareTo(y) must throw an exception if and only if y.compareTo(x) throws an exception.)

The implementor must also ensure that the relation is transitive: (x.compareTo(y) > 0 && y.compareTo(z) > 0) implies x.compareTo(z) > 0.

Finally, the implementor must ensure that x.compareTo(y)==0 implies that signum(x.compareTo(z)) == signum(y.compareTo(z)), for all z.

Parameters

other:CidrAddress: the object to be compared.

Returns:int

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

create back to summary

create	back to summary
public static CidrAddress create(InetAddress networkAddress, int netmaskBits) Create a new CIDR address. Parameters networkAddress:InetAddress the network address (must not be `null`) netmaskBits:int the netmask bits (0-32 for IPv4, or 0-128 for IPv6) Returns:CidrAddress the CIDR address (not `null`)

public static CidrAddress create(InetAddress networkAddress, int netmaskBits)

Create a new CIDR address.

Parameters

networkAddress:InetAddress: the network address (must not be null)
netmaskBits:int: the netmask bits (0-32 for IPv4, or 0-128 for IPv6)

Returns:CidrAddress

the CIDR address (not null)

create back to summary

create	back to summary
public static CidrAddress create(byte[] addressBytes, int netmaskBits) Create a new CIDR address. Parameters addressBytes:byte[] the network address bytes (must not be `null`, must be 4 bytes for IPv4 or 16 bytes for IPv6) netmaskBits:int the netmask bits (0-32 for IPv4, or 0-128 for IPv6) Returns:CidrAddress the CIDR address (not `null`)

public static CidrAddress create(byte[] addressBytes, int netmaskBits)

Create a new CIDR address.

Parameters

addressBytes:byte[]: the network address bytes (must not be null, must be 4 bytes for IPv4 or 16 bytes for IPv6)
netmaskBits:int: the netmask bits (0-32 for IPv4, or 0-128 for IPv6)

Returns:CidrAddress

the CIDR address (not null)

create	back to summary
pack-priv static CidrAddress create(byte[] addressBytes, int netmaskBits, boolean clone)

equals back to summary

equals	back to summary
public boolean equals(final Object obj) Overrides java.lang.Object.equals. Returns `true` if this address is equal to the given object, or `false` if it is not. Parameters obj:Object the other address Returns:boolean `true` if this address is equal to the given object, or `false` if it is not

public boolean equals(final Object obj)

Overrides java.lang.Object.equals.

Returns true if this address is equal to the given object, or false if it is not.

Parameters

obj:Object: the other address

Returns:boolean

true if this address is equal to the given object, or false if it is not

equals back to summary

equals	back to summary
public boolean equals(final CidrAddress obj) Returns `true` if this address is equal to the given address, or `false` if it is not. Parameters obj:CidrAddress the other address Returns:boolean `true` if this address is equal to the given address, or `false` if it is not

public boolean equals(final CidrAddress obj)

Returns true if this address is equal to the given address, or false if it is not.

Parameters

obj:CidrAddress: the other address

Returns:boolean

true if this address is equal to the given address, or false if it is not

getBroadcastAddress back to summary

getBroadcastAddress	back to summary
public Inet4Address getBroadcastAddress() Get the broadcast address for this CIDR block. If the block has no broadcast address (either because it is IPv6 or it is too small) then `null` is returned. Returns:Inet4Address the broadcast address for this CIDR block, or `null` if there is none

public Inet4Address getBroadcastAddress()

Get the broadcast address for this CIDR block. If the block has no broadcast address (either because it is IPv6 or it is too small) then null is returned.

Returns:Inet4Address: the broadcast address for this CIDR block, or null if there is none

getNetmaskBits	back to summary
public int getNetmaskBits() Get the netmask bits. This will be in the range 0-32 for IPv4 addresses, and 0-128 for IPv6 addresses. Returns:int the netmask bits

getNetmaskBits

back to summary

public int getNetmaskBits()

Get the netmask bits. This will be in the range 0-32 for IPv4 addresses, and 0-128 for IPv6 addresses.

Returns:int: the netmask bits

getNetworkAddress back to summary

getNetworkAddress	back to summary
public InetAddress getNetworkAddress() Get the network address. The returned address has a resolved name consisting of the most compact valid string representation of the network of this CIDR address. Returns:InetAddress the network address (not `null`)

public InetAddress getNetworkAddress()

Get the network address. The returned address has a resolved name consisting of the most compact valid string representation of the network of this CIDR address.

Returns:InetAddress: the network address (not null)

getScopeId	back to summary
public int getScopeId() Get the match address scope ID (if it is an IPv6 address). Returns:int the scope ID, or 0 if there is none or the address is an IPv4 address

getScopeId

back to summary

public int getScopeId()

Get the match address scope ID (if it is an IPv6 address).

Returns:int: the scope ID, or 0 if there is none or the address is an IPv4 address

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int: a hash code value for this object

maskBits0	back to summary
private static byte[] maskBits0(byte[] address, int bits)

maskBits1	back to summary
private static byte[] maskBits1(byte[] address, int bits)

matches back to summary

matches	back to summary
public boolean matches(InetAddress address) Determine if this CIDR address matches the given address. Parameters address:InetAddress the address to test Returns:boolean `true` if the address matches, `false` otherwise

public boolean matches(InetAddress address)

Determine if this CIDR address matches the given address.

Parameters

address:InetAddress: the address to test

Returns:boolean

true if the address matches, false otherwise

matches back to summary

matches	back to summary
public boolean matches(byte[] bytes) Determine if this CIDR address matches the given address bytes. Parameters bytes:byte[] the address bytes to test Returns:boolean `true` if the address bytes match, `false` otherwise

public boolean matches(byte[] bytes)

Determine if this CIDR address matches the given address bytes.

Parameters

bytes:byte[]: the address bytes to test

Returns:boolean

true if the address bytes match, false otherwise

matches back to summary

matches	back to summary
public boolean matches(byte[] bytes, int scopeId) Determine if this CIDR address matches the given address bytes. Parameters bytes:byte[] the address bytes to test scopeId:int the scope ID, or 0 to match no scope Returns:boolean `true` if the address bytes match, `false` otherwise

public boolean matches(byte[] bytes, int scopeId)

Determine if this CIDR address matches the given address bytes.

Parameters

bytes:byte[]: the address bytes to test
scopeId:int: the scope ID, or 0 to match no scope

Returns:boolean

true if the address bytes match, false otherwise

matches back to summary

matches	back to summary
public boolean matches(Inet4Address address) Determine if this CIDR address matches the given address. Parameters address:Inet4Address the address to test Returns:boolean `true` if the address matches, `false` otherwise

public boolean matches(Inet4Address address)

Determine if this CIDR address matches the given address.

Parameters

address:Inet4Address: the address to test

Returns:boolean

true if the address matches, false otherwise

matches back to summary

matches	back to summary
public boolean matches(Inet6Address address) Determine if this CIDR address matches the given address. Parameters address:Inet6Address the address to test Returns:boolean `true` if the address matches, `false` otherwise

public boolean matches(Inet6Address address)

Determine if this CIDR address matches the given address.

Parameters

address:Inet6Address: the address to test

Returns:boolean

true if the address matches, false otherwise

matches back to summary

matches	back to summary
public boolean matches(CidrAddress address) Determine if this CIDR address matches the given CIDR address. This will be true only when the given CIDR block is wholly enclosed by this one. Parameters address:CidrAddress the address to test Returns:boolean `true` if the given block is enclosed by this one, `false` otherwise

public boolean matches(CidrAddress address)

Determine if this CIDR address matches the given CIDR address. This will be true only when the given CIDR block is wholly enclosed by this one.

Parameters

address:CidrAddress: the address to test

Returns:boolean

true if the given block is enclosed by this one, false otherwise

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

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

writeReplace	back to summary
pack-priv Object writeReplace() Returns the serialization replacement for this object. Returns:Object the serialization replacement for this object

writeReplace

back to summary

pack-priv Object writeReplace()

Returns the serialization replacement for this object.

Returns:Object: the serialization replacement for this object

public final Class CidrAddress

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv final Class CidrAddress.Ser

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

Modifier and Type	Field and Description
pack-priv final byte[]	b
pack-priv final int	m
private static final long	serialVersionUID