com.bol.ipresource.ip

Class Ipv6Interval

java.lang.Object

com.bol.ipresource.ip.IpInterval<Ipv6Interval>

com.bol.ipresource.ip.Ipv6Interval

All Implemented Interfaces:

Interval<Ipv6Interval>, Comparable<Ipv6Interval>

public class Ipv6Interval
extends IpInterval<Ipv6Interval>
implements Comparable<Ipv6Interval>

Efficient representation of an IPv6 address range. Internally IPv6 addresses are stored as 2 signed 64-bit longs.

Note that while ipv6 addresses are always prefixes, this class also allows for ranges that cannot be represented as prefix.

Field Summary

Fields

Modifier and Type	Field and Description
static String	IPV6_DOTLESS_REVERSE_DOMAIN
static String	IPV6_REVERSE_DOMAIN
static Ipv6Interval	MAX_RANGE

Constructor Summary

Constructors

Constructor and Description
Ipv6Interval(BigInteger begin, BigInteger end)
Ipv6Interval(BigInteger address, int prefixLength)
Ipv6Interval(long msb, long lsb, int prefixLength)
Ipv6Interval(long beginMsb, long beginLsb, long endMsb, long endLsb)
Ipv6Interval(String msb, String lsb, int prefixLength)

Method Summary

Modifier and Type	Method and Description
String	beginAddressAsString()
BigInteger	beginAsBigInteger()
byte[]	beginAsByteArray()
InetAddress	beginAsInetAddress()
static int	compare(long aMsb, long aLsb, long bMsb, long bLsb)
int	compareTo(Ipv6Interval that)
int	compareUpperBound(Ipv6Interval that) Compare two intervals based on their upper-bounds.
boolean	contains(Ipv6Interval that) Tests if this interval contains that.
String	endAddressAsString()
BigInteger	endAsBigInteger()
byte[]	endAsByteArray()
InetAddress	endAsInetAddress()
boolean	equals(Object obj)
int	getPrefixLength()
int	hashCode()
boolean	intersects(Ipv6Interval that) Tests if these two intervals intersect.
static long	lsb(BigInteger begin)
static long	msb(BigInteger begin)
static Ipv6Interval	parse(InetAddress ipv6Address)
static Ipv6Interval	parse(InetAddress ipv6Address, int prefixLength)
static Ipv6Interval	parse(String prefixOrAddress)
static Ipv6Interval	parseIpAddress(String ipAddress)
static Ipv6Interval	parseReverseDomain(String address)
Ipv6Interval	singletonIntervalAtLowerBound() Copies this interval into a new interval that has both its lower and upper-bound set to the original's lower-bound.
String	toPrefixString()
String	toRangeString()
String	toReverseDomain()
String	toString()

Methods inherited from class com.bol.ipresource.ip.IpInterval

asIpInterval, valueOf

Methods inherited from class java.lang.Object

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

Field Detail

IPV6_DOTLESS_REVERSE_DOMAIN

public static final String IPV6_DOTLESS_REVERSE_DOMAIN

See Also:

Constant Field Values

IPV6_REVERSE_DOMAIN

public static final String IPV6_REVERSE_DOMAIN

See Also:

Constant Field Values

MAX_RANGE

public static final Ipv6Interval MAX_RANGE

Constructor Detail

Ipv6Interval

public Ipv6Interval(BigInteger address,
                    int prefixLength)

Ipv6Interval

public Ipv6Interval(String msb,
                    String lsb,
                    int prefixLength)

Ipv6Interval

public Ipv6Interval(long msb,
                    long lsb,
                    int prefixLength)

Ipv6Interval

public Ipv6Interval(BigInteger begin,
                    BigInteger end)

Ipv6Interval

public Ipv6Interval(long beginMsb,
                    long beginLsb,
                    long endMsb,
                    long endLsb)

Method Detail

parse

public static Ipv6Interval parse(InetAddress ipv6Address)

parse

public static Ipv6Interval parse(InetAddress ipv6Address,
                                 int prefixLength)

parse

public static Ipv6Interval parse(String prefixOrAddress)

parseIpAddress

public static Ipv6Interval parseIpAddress(String ipAddress)

parseReverseDomain

public static Ipv6Interval parseReverseDomain(String address)

beginAsBigInteger

public BigInteger beginAsBigInteger()

endAsBigInteger

public BigInteger endAsBigInteger()

compare

public static int compare(long aMsb,
                          long aLsb,
                          long bMsb,
                          long bLsb)

compareTo

public int compareTo(Ipv6Interval that)

Specified by:

compareTo in interface Comparable<Ipv6Interval>

contains

public boolean contains(Ipv6Interval that)

Description copied from interface: Interval

Tests if this interval contains that. Note that if two intervals are equal, they also contain each other (and vice versa). An interval always contains itself.

Specified by:

contains in interface Interval<Ipv6Interval>

Parameters:

that - the interval to test for containment

Returns:

true if this contains that interval

intersects

public boolean intersects(Ipv6Interval that)

Description copied from interface: Interval

Tests if these two intervals intersect. Two intervals intersect if there exists a point which is contained within both intervals. An interval always intersects itself.

Specified by:

intersects in interface Interval<Ipv6Interval>

Parameters:

that - the other interval to test for intersection

Returns:

true if this interval intersects that interval

singletonIntervalAtLowerBound

public Ipv6Interval singletonIntervalAtLowerBound()

Description copied from interface: Interval

Copies this interval into a new interval that has both its lower and upper-bound set to the original's lower-bound. This is used to be able to compare an interval's lower-bound with another interval's upper-bound.

   Interval a = ...
   Interval b = ...
   if (a.singletonIntervalAtLowerBound().compareUpperBoundTo(b) < 0) ...
 

Specified by:

singletonIntervalAtLowerBound in interface Interval<Ipv6Interval>

Returns:

a new interval that has both its lower- and upper-bound set to this interval's lower-bound

compareUpperBound

public int compareUpperBound(Ipv6Interval that)

Description copied from interface: Interval

Compare two intervals based on their upper-bounds. This is used by the NestedIntervalMap implementation to quickly find two potentially intersecting intervals by ordering intervals on the upper-bound and searching based on the lower-bound.

Specified by:

compareUpperBound in interface Interval<Ipv6Interval>

Parameters:

that - the interval to compare the upper-bound with

Returns:

<0 if this upper-bound is less than that upper-bound,
=0 if this upper-bound equals that upper-bound,
>0 if this upper-bound is greater than that upper-bound

beginAsInetAddress

public InetAddress beginAsInetAddress()

Specified by:

beginAsInetAddress in class IpInterval<Ipv6Interval>

endAsInetAddress

public InetAddress endAsInetAddress()

Specified by:

endAsInetAddress in class IpInterval<Ipv6Interval>

beginAsByteArray

public byte[] beginAsByteArray()

Specified by:

beginAsByteArray in class IpInterval<Ipv6Interval>

endAsByteArray

public byte[] endAsByteArray()

Specified by:

endAsByteArray in class IpInterval<Ipv6Interval>

getPrefixLength

public int getPrefixLength()

Specified by:

getPrefixLength in class IpInterval<Ipv6Interval>

toString

public String toString()

Overrides:

toString in class Object

toRangeString

public String toRangeString()

Specified by:

toRangeString in class IpInterval<Ipv6Interval>

toPrefixString

public String toPrefixString()

Specified by:

toPrefixString in class IpInterval<Ipv6Interval>

toReverseDomain

public String toReverseDomain()

Specified by:

toReverseDomain in class IpInterval<Ipv6Interval>

beginAddressAsString

public String beginAddressAsString()

Specified by:

beginAddressAsString in class IpInterval<Ipv6Interval>

endAddressAsString

public String endAddressAsString()

Specified by:

endAddressAsString in class IpInterval<Ipv6Interval>

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

lsb

public static long lsb(BigInteger begin)

msb

public static long msb(BigInteger begin)