IPv6Address (ineter 0.1.2 API)

java.lang.Object
- com.github.maltalex.ineter.base.IPAddress
- - com.github.maltalex.ineter.base.IPv6Address

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<IPv6Address>

Direct Known Subclasses:

ZonedIPv6Address
```
public class IPv6Address
extends IPAddress
implements java.lang.Comparable<IPv6Address>
```
See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`IPv6Address.IPv6KnownRange`
`protected static class`	`IPv6Address.LongByte` Enum for extracting bytes from 64-bit longs
`protected static class`	`IPv6Address.LongShort` Enum for extracting 16-bit shorts from 64-bit longs

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ADDRESS_BITS`
`static int`	`ADDRESS_BYTES`
`static int`	`ADDRESS_SHORTS`
`static int`	`HOLDER_BITS`
`protected long`	`lower`
`protected long`	`upper`

Constructor Summary

Constructors
Constructor and Description

IPv6Address(long upper, long lower)
Build an IPv6Address from two longs - upper and lower 64 bits in form of longs

Constructors
Constructor and Description
`IPv6Address(long upper, long lower)` Build an IPv6Address from two longs - upper and lower 64 bits in form of longs

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(IPv6Address o)`
`boolean`	`equals(java.lang.Object obj)`
`long`	`getLower()` return lower 64 bits of the address in long form
`long`	`getUpper()` return upper 64 bits of the address in long form
`int`	`hashCode()`
`boolean`	`is6To4()` Checks whether the given address is a 6to4 address
`boolean`	`isGlobalUnicast()` Is this an IPv6 global unicast address?
`protected static boolean`	`isHexDigit(char c)`
`boolean`	`isIPv4Translation()` Is this one of the IPv6 addresses reserved for IPv4-IPv6 translation - Teredo, IPv4-mapped-IPv6, 6to4, or IPv4-embedded-IPv6?
`boolean`	`isLinkLocal()` Checks whether the address is link-local
`boolean`	`isLoopback()` Checks whether the address is a loopback address
`boolean`	`isMartian()` Martian addresses are reserved and private addresses that should not appear on the public internet
`boolean`	`isMulticast()` Checks whether the address is part of a range reserved for multicast
`boolean`	`isPrivate()` Checks whether the address is private
`boolean`	`isReserved()` Checks whether the address part of a reserved range
`boolean`	`isUnspecified()` Checks whether the address is "unspecified"
`boolean`	`isZoned()` does this address have a specific zone?
`protected int`	`longCompare(IPv6Address o)`
`IPv6Address`	`minus(int n)` Return an address smaller than the current one by n, with wraparound
`IPv6Address`	`minus(long n)` Return an address smaller than the current one by n, with wraparound
`IPv6Address`	`next()` Returns the following address, with wraparound
`static IPv6Address`	`of(byte[] bigEndianByteArr)` Build an IPv6Address from a 16 byte long big-endian (highest byte first) byte array
`static IPv6Address`	`of(java.net.Inet6Address address)` Build an IPv6Address from an Inet6Address
`static IPv6Address`	`of(long upper, long lower)` Build an IPv6Address from two longs - upper and lower 64 bits in form of longs
`static IPv6Address`	`of(java.lang.String address)` Build an IPv6Address or a ZonedIPv6Address from a literal IPv6 address in String from such as "2001:1:2:3:4:5:6:7", "2001::", "[::]", "fe80::1%eth0", and similar valid forms
`IPv6Address`	`plus(int n)` Return an address larger than the current one by n, with wraparound
`IPv6Address`	`plus(long n)` Return an address larger than the current one by n, with wraparound
`IPv6Address`	`previous()` Returns the previous address, with wraparound
`byte[]`	`toBigEndianArray()` The address as an array of bytes, with the highest byte first
`java.net.Inet6Address`	`toInet6Address()`
`byte[]`	`toLittleEndianArray()` The address as an array of bytes, with the highest byte last
`java.lang.String`	`toString()`
`protected static int`	`unsignedCompare(long a, long b)`
`protected static void`	`verifyArray(byte[] bigEndianByteArr)`
`int`	`version()` Returns the version of the IP address

Methods inherited from class com.github.maltalex.ineter.base.IPAddress
of, toArray, toBigInteger, toInetAddress, toSignedBigInteger

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

- Field Detail
  - ADDRESS_BITS
```
public static final int ADDRESS_BITS
```
    See Also:
    
    Constant Field Values
  - ADDRESS_BYTES
```
public static final int ADDRESS_BYTES
```
    See Also:
    
    Constant Field Values
  - ADDRESS_SHORTS
```
public static final int ADDRESS_SHORTS
```
    See Also:
    
    Constant Field Values
  - HOLDER_BITS
```
public static final int HOLDER_BITS
```
    See Also:
    
    Constant Field Values
  - upper
```
protected final long upper
```
  - lower
```
protected final long lower
```
- Constructor Detail
  - IPv6Address
```
public IPv6Address(long upper,
                   long lower)
```
    Build an IPv6Address from two longs - upper and lower 64 bits in form of longs
    
    Parameters:
    
    upper - upper 64 bits of the IPv6Address
    
    lower - lower 64 bits of the IPv6Address
- Method Detail
  - of
```
public static IPv6Address of(long upper,
                             long lower)
```
    Build an IPv6Address from two longs - upper and lower 64 bits in form of longs
    
    Parameters:
    
    upper - upper 64 bits of the IPv6Address
    
    lower - lower 64 bits of the IPv6Address
    
    Returns:
    
    new IPv6Address instance
  - verifyArray
```
protected static void verifyArray(byte[] bigEndianByteArr)
```
  - of
```
public static IPv6Address of(byte[] bigEndianByteArr)
```
    Build an IPv6Address from a 16 byte long big-endian (highest byte first) byte array
    
    Parameters:
    
    bigEndianByteArr - 16 byte big-endian byte array
    
    Returns:
    
    new IPv6Address instance
  - of
```
public static IPv6Address of(java.net.Inet6Address address)
```
    Build an IPv6Address from an Inet6Address
    
    Parameters:
    
    address -
    
    Returns:
    
    new IPv6Address instance
  - of
```
public static IPv6Address of(java.lang.String address)
```
    Build an IPv6Address or a ZonedIPv6Address from a literal IPv6 address in String from such as "2001:1:2:3:4:5:6:7", "2001::", "[::]", "fe80::1%eth0", and similar valid forms
    
    Parameters:
    
    address -
    
    Returns:
    
    new IPv6Address instance
  - isHexDigit
```
protected static boolean isHexDigit(char c)
```
  - unsignedCompare
```
protected static int unsignedCompare(long a,
                                     long b)
```
  - 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
  - getUpper
```
public long getUpper()
```
    return upper 64 bits of the address in long form
    
    Returns:
    
    upper 64 bits
  - getLower
```
public long getLower()
```
    return lower 64 bits of the address in long form
    
    Returns:
    
    lower 64 bits
  - is6To4
```
public boolean is6To4()
```
    Description copied from class: IPAddress
    
    Checks whether the given address is a 6to4 address
    
    Specified by:
    
    is6To4 in class IPAddress
    
    Returns:
    
    true if the give address is a 6to4 address, false otherwise
  - isMartian
```
public boolean isMartian()
```
    Description copied from class: IPAddress
    
    Martian addresses are reserved and private addresses that should not appear on the public internet
    
    Specified by:
    
    isMartian in class IPAddress
    
    Returns:
    
    true if the address is martian, false otherwise
  - isIPv4Translation
```
public boolean isIPv4Translation()
```
    Is this one of the IPv6 addresses reserved for IPv4-IPv6 translation - Teredo, IPv4-mapped-IPv6, 6to4, or IPv4-embedded-IPv6?
    
    Returns:
    
    true if this is a IPv4-IPv6 translation address
  - isLoopback
```
public boolean isLoopback()
```
    Description copied from class: IPAddress
    
    Checks whether the address is a loopback address
    
    Specified by:
    
    isLoopback in class IPAddress
    
    Returns:
    
    true if the address is for a loopback, false otherwise
  - isGlobalUnicast
```
public boolean isGlobalUnicast()
```
    Is this an IPv6 global unicast address?
    
    Returns:
    
    true if this is a global unicast address
  - isLinkLocal
```
public boolean isLinkLocal()
```
    Description copied from class: IPAddress
    
    Checks whether the address is link-local
    
    Specified by:
    
    isLinkLocal in class IPAddress
    
    Returns:
    
    true if the address is link-local, false otherwise
  - isMulticast
```
public boolean isMulticast()
```
    Description copied from class: IPAddress
    
    Checks whether the address is part of a range reserved for multicast
    
    Specified by:
    
    isMulticast in class IPAddress
    
    Returns:
    
    true if the address is reserved for multicast, false otherwise
  - isPrivate
```
public boolean isPrivate()
```
    Description copied from class: IPAddress
    
    Checks whether the address is private
    
    Specified by:
    
    isPrivate in class IPAddress
    
    Returns:
    
    true if the address is private, false otherwise
  - isReserved
```
public boolean isReserved()
```
    Description copied from class: IPAddress
    
    Checks whether the address part of a reserved range
    
    Specified by:
    
    isReserved in class IPAddress
    
    Returns:
    
    true if the address is part of a reserved range, false otherwise
  - isUnspecified
```
public boolean isUnspecified()
```
    Description copied from class: IPAddress
    
    Checks whether the address is "unspecified"
    
    Specified by:
    
    isUnspecified in class IPAddress
    
    Returns:
    
    true if the address is "unspecified", false otherwise
  - next
```
public IPv6Address next()
```
    Description copied from class: IPAddress
    
    Returns the following address, with wraparound
    
    Specified by:
    
    next in class IPAddress
    
    Returns:
    
    the address following this one
  - plus
```
public IPv6Address plus(long n)
```
    Return an address larger than the current one by n, with wraparound
    
    Parameters:
    
    n -
    
    Returns:
    
    an address larger by n
  - plus
```
public IPv6Address plus(int n)
```
    Description copied from class: IPAddress
    
    Return an address larger than the current one by n, with wraparound
    
    Specified by:
    
    plus in class IPAddress
    
    Returns:
    
    an address larger by n
  - previous
```
public IPv6Address previous()
```
    Description copied from class: IPAddress
    
    Returns the previous address, with wraparound
    
    Specified by:
    
    previous in class IPAddress
    
    Returns:
    
    the address before this one
  - minus
```
public IPv6Address minus(int n)
```
    Description copied from class: IPAddress
    
    Return an address smaller than the current one by n, with wraparound
    
    Specified by:
    
    minus in class IPAddress
    
    Returns:
    
    an address smaller by n
  - minus
```
public IPv6Address minus(long n)
```
    Return an address smaller than the current one by n, with wraparound
    
    Parameters:
    
    n -
    
    Returns:
    
    an address smaller by n
  - toBigEndianArray
```
public byte[] toBigEndianArray()
```
    Description copied from class: IPAddress
    
    The address as an array of bytes, with the highest byte first
    
    Specified by:
    
    toBigEndianArray in class IPAddress
    
    Returns:
    
    big-endian byte array
  - toLittleEndianArray
```
public byte[] toLittleEndianArray()
```
    Description copied from class: IPAddress
    
    The address as an array of bytes, with the highest byte last
    
    Specified by:
    
    toLittleEndianArray in class IPAddress
    
    Returns:
    
    little-endian byte array
  - compareTo
```
public int compareTo(IPv6Address o)
```
    Specified by:
    
    compareTo in interface java.lang.Comparable<IPv6Address>
  - longCompare
```
protected int longCompare(IPv6Address o)
```
  - toInet6Address
```
public java.net.Inet6Address toInet6Address()
```
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - version
```
public int version()
```
    Description copied from class: IPAddress
    
    Returns the version of the IP address
    
    Specified by:
    
    version in class IPAddress
    
    Returns:
    
    4 for IPv4, 6 for IPv6
  - isZoned
```
public boolean isZoned()
```
    does this address have a specific zone?
    
    Returns:
    
    false

Class IPv6Address

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.github.maltalex.ineter.base.IPAddress

Methods inherited from class java.lang.Object

Field Detail

ADDRESS_BITS

ADDRESS_BYTES

ADDRESS_SHORTS

HOLDER_BITS

upper

lower

Constructor Detail

IPv6Address

Method Detail

of

verifyArray

of

of

of

isHexDigit

unsignedCompare

hashCode

equals

getUpper

getLower

is6To4

isMartian

isIPv4Translation

isLoopback

isGlobalUnicast

isLinkLocal

isMulticast

isPrivate

isReserved

isUnspecified

next

plus

plus

previous

minus

minus

toBigEndianArray

toLittleEndianArray

compareTo

longCompare

toInet6Address

toString

version

isZoned