com.googlecode.ipv6

Class IPv6Address

java.lang.Object

com.googlecode.ipv6.IPv6Address

All Implemented Interfaces:

Comparable<IPv6Address>

public final class IPv6Address
extends Object
implements Comparable<IPv6Address>

Immutable representation of an IPv6 address.

Author:

Jan Van Besien

Field Summary

Fields

Modifier and Type	Field and Description
static IPv6Address	MAX

Method Summary

Methods

Modifier and Type	Method and Description
IPv6Address	add(int value) Addition.
int	compareTo(IPv6Address that)
boolean	equals(Object o)
static IPv6Address	fromBigInteger(BigInteger bigInteger) Create an IPv6 address from a (positive) BigInteger.
static IPv6Address	fromByteArray(byte[] bytes) Create an IPv6 address from a byte array.
static IPv6Address	fromInetAddress(InetAddress inetAddress) Create an IPv6 address from a java.net.Inet6Address.
static IPv6Address	fromLongs(long highBits, long lowBits) Construct an IPv6Address from two longs representing the 64 highest and 64 lowest bits.
static IPv6Address	fromString(String string) Create an IPv6 address from its String representation.
long	getHighBits()
long	getLowBits()
int	hashCode()
boolean	isIPv4Mapped() Returns true if the address is an IPv4-mapped IPv6 address.
boolean	isLinkLocal()
boolean	isMulticast()
boolean	isSiteLocal()
IPv6Address	maskWithNetworkMask(IPv6NetworkMask networkMask) Mask the address with the given network mask.
IPv6Address	maximumAddressWithNetworkMask(IPv6NetworkMask networkMask) Calculate the maximum address with the given network mask.
int	numberOfLeadingOnes()
int	numberOfLeadingZeroes()
int	numberOfTrailingOnes()
int	numberOfTrailingZeroes()
IPv6Address	setBit(int bit) Set a bit in the address.
IPv6Address	subtract(int value) Subtraction.
BigInteger	toBigInteger()
byte[]	toByteArray()
InetAddress	toInetAddress()
String	toLongString()
String	toString() Returns a string representation of the IPv6 address.

Methods inherited from class java.lang.Object

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

Field Detail

MAX

public static final IPv6Address MAX

Method Detail

fromLongs

public static IPv6Address fromLongs(long highBits,
                    long lowBits)

Construct an IPv6Address from two longs representing the 64 highest and 64 lowest bits. It is usually easier to construct IPv6Addresses from a String or an InetAddress. The internal representation of an IPv6Address is exactly these two longs though, so if you already happen to have them, this provides a very efficient way to construct an IPv6Address.

Parameters:

highBits - highest order bits

lowBits - lowest order bits

fromString

public static IPv6Address fromString(String string)

Create an IPv6 address from its String representation. For example "1234:5678:abcd:0000:9876:3210:ffff:ffff" or "2001::ff" or even "::". IPv4-Mapped IPv6 addresses such as "::ffff:123.456.123.456" are also supported.

Parameters:

string - string representation

Returns:

IPv6 address

fromInetAddress

public static IPv6Address fromInetAddress(InetAddress inetAddress)

Create an IPv6 address from a java.net.Inet6Address.

Parameters:

inetAddress - Inet6Address representation

Returns:

IPv6 address

toInetAddress

public InetAddress toInetAddress()
                          throws UnknownHostException

Throws:

UnknownHostException

fromByteArray

public static IPv6Address fromByteArray(byte[] bytes)

Create an IPv6 address from a byte array.

Parameters:

bytes - byte array with 16 bytes (interpreted unsigned)

Returns:

IPv6 address

toByteArray

public byte[] toByteArray()

Returns:

byte[] representation

fromBigInteger

public static IPv6Address fromBigInteger(BigInteger bigInteger)

Create an IPv6 address from a (positive) BigInteger. The magnitude of the BigInteger represents the IPv6 address value. Or in other words, the BigInteger with value N defines the Nth possible IPv6 address.

Parameters:

bigInteger - BigInteger value

Returns:

IPv6 address

toBigInteger

public BigInteger toBigInteger()

Returns:

BigInteger representation. The magnitude of the BigInteger represents the IPv6 address value. Or in other words, the BigInteger with value N defines the Nth possible IPv6 address.

add

public IPv6Address add(int value)

Addition. Will never overflow, but wraps around when the highest ip address has been reached.

Parameters:

value - value to add

Returns:

new IPv6 address

subtract

public IPv6Address subtract(int value)

Subtraction. Will never underflow, but wraps around when the lowest ip address has been reached.

Parameters:

value - value to substract

Returns:

new IPv6 address

maskWithNetworkMask

public IPv6Address maskWithNetworkMask(IPv6NetworkMask networkMask)

Mask the address with the given network mask.

Parameters:

networkMask - network mask

Returns:

an address of which the last 128 - networkMask.asPrefixLength() bits are zero

maximumAddressWithNetworkMask

public IPv6Address maximumAddressWithNetworkMask(IPv6NetworkMask networkMask)

Calculate the maximum address with the given network mask.

Parameters:

networkMask - network mask

Returns:

an address of which the last 128 - networkMask.asPrefixLength() bits are one

setBit

public IPv6Address setBit(int bit)

Set a bit in the address.

Parameters:

bit - to set (in the range [0, 127])

Returns:

an address with the given bit set

isIPv4Mapped

public boolean isIPv4Mapped()

Returns true if the address is an IPv4-mapped IPv6 address. In these addresses, the first 80 bits are zero, the next 16 bits are one, and the remaining 32 bits are the IPv4 address.

Returns:

true if the address is an IPv4-mapped IPv6 addresses.

isMulticast

public boolean isMulticast()

Returns:

true if the address is an IPv6 multicast address (an address in the network ff00::/8)

isSiteLocal

public boolean isSiteLocal()

Returns:

true if the address is an IPv6 site-local address (an address in the network fec0::/48)

isLinkLocal

public boolean isLinkLocal()

Returns:

true if the address is an IPv6 link-local address (an address in the network fe80::/48)

toString

public String toString()

Returns a string representation of the IPv6 address. It will use shorthand notation and special notation for IPv4-mapped IPv6 addresses whenever possible.

Overrides:

toString in class Object

Returns:

String representation of the IPv6 address

toLongString

public String toLongString()

Returns:

String representation of the IPv6 address, never using shorthand notation.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

compareTo

public int compareTo(IPv6Address that)

Specified by:

compareTo in interface Comparable<IPv6Address>

getHighBits

public long getHighBits()

getLowBits

public long getLowBits()

numberOfTrailingZeroes

public int numberOfTrailingZeroes()

numberOfTrailingOnes

public int numberOfTrailingOnes()

numberOfLeadingZeroes

public int numberOfLeadingZeroes()

numberOfLeadingOnes

public int numberOfLeadingOnes()