Package org.opennms.integration.api.v1.model.immutables

Class ImmutableIPAddress

java.lang.Object

org.opennms.integration.api.v1.model.immutables.ImmutableIPAddress

All Implemented Interfaces:

java.lang.Comparable<ImmutableIPAddress>

public class ImmutableIPAddress
extends java.lang.Object
implements java.lang.Comparable<ImmutableIPAddress>

Field Summary

Fields

Modifier and Type	Field	Description
protected java.net.InetAddress	m_inetAddress

Constructor Summary

Constructors

Constructor	Description
ImmutableIPAddress(byte[] ipAddrOctets)
ImmutableIPAddress(java.lang.String dottedNotation)
ImmutableIPAddress(java.net.InetAddress inetAddress)
ImmutableIPAddress(ImmutableIPAddress addr)

Method Summary

Modifier and Type	Method	Description
int	compareTo(ImmutableIPAddress o)
ImmutableIPAddress	decr()	Decrement this IP address.
boolean	equals(java.lang.Object obj)
static int	fromBytes(byte b1, byte b2, byte b3, byte b4)	Returns the int value whose byte representation is the given 4 bytes, in big-endian order; equivalent to Ints.fromByteArray(new byte[] {b1, b2, b3, b4}).
int	hashCode()
ImmutableIPAddress	incr()	Increment this IP address.
boolean	isGreaterThan(ImmutableIPAddress other)	Check if this IP address is larger than the provided IP address.
boolean	isGreaterThanOrEqualTo(ImmutableIPAddress other)	Check if this IP address is larger or equal to the provided IP address.
boolean	isLessThan(ImmutableIPAddress other)	Check if this IP address is smaller than the provided IP address.
boolean	isLessThanOrEqualTo(ImmutableIPAddress other)	Check if this IP address is smaller or equal to the provided IP address.
boolean	isPredecessorOf(ImmutableIPAddress other)	Check if this IP address is immediately before the provided IP address.
boolean	isSuccessorOf(ImmutableIPAddress other)	Check if this IP address is immediately after the provided IP address.
static ImmutableIPAddress	max(ImmutableIPAddress a, ImmutableIPAddress b)	Return the larger of two IP addresses.
static ImmutableIPAddress	min(ImmutableIPAddress a, ImmutableIPAddress b)
java.math.BigInteger	toBigInteger()
java.lang.String	toDbString()
java.net.InetAddress	toInetAddress()
protected byte[]	toIpAddrBytes(java.lang.String dottedNotation)
protected java.lang.String	toIpAddrString(byte[] addr)
protected java.lang.String	toIpAddrString(java.net.InetAddress addr)
byte[]	toOctets()
java.lang.String	toString()
java.lang.String	toUserString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

m_inetAddress

protected final java.net.InetAddress m_inetAddress

Constructor Detail

ImmutableIPAddress

public ImmutableIPAddress(ImmutableIPAddress addr)

ImmutableIPAddress

public ImmutableIPAddress(java.lang.String dottedNotation)

ImmutableIPAddress

public ImmutableIPAddress(java.net.InetAddress inetAddress)

ImmutableIPAddress

public ImmutableIPAddress(byte[] ipAddrOctets)

Method Detail

min

public static ImmutableIPAddress min(ImmutableIPAddress a,
                                     ImmutableIPAddress b)

toInetAddress

public java.net.InetAddress toInetAddress()

toOctets

public byte[] toOctets()

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

compareTo

public int compareTo(ImmutableIPAddress o)

Specified by:

compareTo in interface java.lang.Comparable<ImmutableIPAddress>

toUserString

public java.lang.String toUserString()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toDbString

public java.lang.String toDbString()

toBigInteger

public java.math.BigInteger toBigInteger()

incr

public ImmutableIPAddress incr()

Increment this IP address.

Returns:

the new IP address

Throws:

java.lang.IllegalStateException - if it overflows

decr

public ImmutableIPAddress decr()

Decrement this IP address.

Returns:

the new IP address

Throws:

java.lang.IllegalStateException - if it underflows

isPredecessorOf

public boolean isPredecessorOf(ImmutableIPAddress other)

Check if this IP address is immediately before the provided IP address.

Parameters:

other - the address to check against

Returns:

a boolean

isSuccessorOf

public boolean isSuccessorOf(ImmutableIPAddress other)

Check if this IP address is immediately after the provided IP address.

Parameters:

other - the address to check against

Returns:

a boolean

isLessThan

public boolean isLessThan(ImmutableIPAddress other)

Check if this IP address is smaller than the provided IP address.

Parameters:

other - the address to check against

Returns:

a boolean

isLessThanOrEqualTo

public boolean isLessThanOrEqualTo(ImmutableIPAddress other)

Check if this IP address is smaller or equal to the provided IP address.

Parameters:

other - the address to check against

Returns:

a boolean

isGreaterThan

public boolean isGreaterThan(ImmutableIPAddress other)

Check if this IP address is larger than the provided IP address.

Parameters:

other - the address to check against

Returns:

a boolean

isGreaterThanOrEqualTo

public boolean isGreaterThanOrEqualTo(ImmutableIPAddress other)

Check if this IP address is larger or equal to the provided IP address.

Parameters:

other - the address to check against

Returns:

a boolean

max

public static ImmutableIPAddress max(ImmutableIPAddress a,
                                     ImmutableIPAddress b)

Return the larger of two IP addresses.

toIpAddrString

protected java.lang.String toIpAddrString(java.net.InetAddress addr)

toIpAddrString

protected java.lang.String toIpAddrString(byte[] addr)

toIpAddrBytes

protected byte[] toIpAddrBytes(java.lang.String dottedNotation)

fromBytes

public static int fromBytes(byte b1,
                            byte b2,
                            byte b3,
                            byte b4)

Returns the int value whose byte representation is the given 4 bytes, in big-endian order; equivalent to Ints.fromByteArray(new byte[] {b1, b2, b3, b4}).

From: Guava.