Home How it Works Android APIMiner IDE Version More Info

to top

Summary: Methods | Inherited Methods | [Expand All]

Added in API level 1

public final class

Inet6Address

extends InetAddress

java.lang.Object
↳	java.net.InetAddress
	↳	java.net.Inet6Address

Class Overview

An IPv6 address. See InetAddress.

Summary

Public Methods
static Inet6Address	getByAddress( String host, byte[] addr, int scope_id) Constructs an IPv6 address according to the given `host`, `addr` and `scope_id`.
static Inet6Address	getByAddress( String host, byte[] addr, NetworkInterface nif) Gets an IPv6 address instance according to the given `host`, `addr` and `nif`.
int	getScopeId() Returns the scope id if this address is scoped to an interface, 0 otherwise.
NetworkInterface	getScopedInterface() Returns the network interface if this address is instanced with a scoped network interface, null otherwise.
boolean	isAnyLocalAddress() Returns whether this is the IPv6 unspecified wildcard address `::` or the IPv4 "any" address, `0.0.0.0`.
boolean	isIPv4CompatibleAddress() Returns whether this IPv6 address is an IPv4-compatible address or not.
boolean	isLinkLocalAddress() Returns whether this address is a link-local address or not.
boolean	isLoopbackAddress() Returns whether this address is a loopback address or not.
boolean	isMCGlobal() Returns whether this address is a global multicast address or not.
boolean	isMCLinkLocal() Returns whether this address is a link-local multicast address or not.
boolean	isMCNodeLocal() Returns whether this address is a node-local multicast address or not.
boolean	isMCOrgLocal() Returns whether this address is a organization-local multicast address or not.
boolean	isMCSiteLocal() Returns whether this address is a site-local multicast address or not.
boolean	isMulticastAddress() Returns whether this address is a multicast address or not.
boolean	isSiteLocalAddress() Returns whether this address is a site-local address or not.
String	toString() Returns a string containing the host name (if available) and host address.

[Expand]

Inherited Methods

From class java.net.InetAddress

boolean	equals( Object obj) Compares this `InetAddress` instance against the specified address in `obj`.
byte[]	getAddress() Returns the IP address represented by this `InetAddress` instance as a byte array.
static InetAddress[]	getAllByName( String host) Gets all IP addresses associated with the given `host` identified by name or literal IP address.
static InetAddress	getByAddress(byte[] ipAddress) Equivalent to `getByAddress(null, ipAddress)`.
static InetAddress	getByAddress( String hostName, byte[] ipAddress) Returns an `InetAddress` corresponding to the given network-order bytes `ipAddress` and `scopeId`.
static InetAddress	getByName( String host) Returns the address of a host according to the given host string name `host`.
String	getCanonicalHostName() Returns the fully qualified hostname corresponding to this IP address.
String	getHostAddress() Returns the numeric representation of this IP address (such as "127.0.0.1").
String	getHostName() Returns the host name corresponding to this IP address.
static InetAddress	getLocalHost() Returns an `InetAddress` for the local host if possible, or the loopback address otherwise.
int	hashCode() Gets the hashcode of the represented IP address.
boolean	isAnyLocalAddress() Returns whether this is the IPv6 unspecified wildcard address `::` or the IPv4 "any" address, `0.0.0.0`.
boolean	isLinkLocalAddress() Returns whether this address is a link-local address or not.
boolean	isLoopbackAddress() Returns whether this address is a loopback address or not.
boolean	isMCGlobal() Returns whether this address is a global multicast address or not.
boolean	isMCLinkLocal() Returns whether this address is a link-local multicast address or not.
boolean	isMCNodeLocal() Returns whether this address is a node-local multicast address or not.
boolean	isMCOrgLocal() Returns whether this address is a organization-local multicast address or not.
boolean	isMCSiteLocal() Returns whether this address is a site-local multicast address or not.
boolean	isMulticastAddress() Returns whether this address is a multicast address or not.
boolean	isReachable(int timeout) Tries to reach this `InetAddress`.
boolean	isReachable( NetworkInterface networkInterface, int ttl, int timeout) Tries to reach this `InetAddress`.
boolean	isSiteLocalAddress() Returns whether this address is a site-local address or not.
String	toString() Returns a string containing the host name (if available) and host address.

From class java.lang.Object

Object	clone() Creates and returns a copy of this `Object`.
boolean	equals( Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of `Class` that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.
final void	wait(long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait(long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.

Public Methods

public static Inet6Address getByAddress (String host, byte[] addr, int scope_id)

Added in API level 1

Constructs an IPv6 address according to the given host, addr and scope_id.

Parameters

host	the host name associated with the address.
addr	the network address.
scope_id	the scope id for link- or site-local addresses.

Returns

the Inet6Address instance representing the IP address.

Throws

UnknownHostException	if the address is null or has an invalid length.

public static Inet6Address getByAddress (String host, byte[] addr, NetworkInterface nif)

Added in API level 1

Gets an IPv6 address instance according to the given host, addr and nif. scope_id is set according to the given nif and the addr type (for example site-local or link-local).

Parameters

host	the hostname associated with the address.
addr	the network address.
nif	the network interface that this address is associated with.

Returns

the Inet6Address instance representing the IP address.

Throws

UnknownHostException	if the address is `null` or has an invalid length or the interface doesn't have a numeric scope id for the given address type.

public int getScopeId ()

Added in API level 1

Returns the scope id if this address is scoped to an interface, 0 otherwise.

public NetworkInterface getScopedInterface ()

Added in API level 1

Returns the network interface if this address is instanced with a scoped network interface, null otherwise.

public boolean isAnyLocalAddress ()

Added in API level 1

Returns whether this is the IPv6 unspecified wildcard address :: or the IPv4 "any" address, 0.0.0.0.

public boolean isIPv4CompatibleAddress ()

Added in API level 1

Returns whether this IPv6 address is an IPv4-compatible address or not. An IPv4-compatible address has the prefix ::/96 and is a deprecated and no-longer used equivalent of the modern IPv4-mapped IPv6 addresses.

public boolean isLinkLocalAddress ()

Added in API level 1

Returns whether this address is a link-local address or not.

Valid IPv6 link-local addresses have the prefix fe80::/10.

RFC 3484 "Default Address Selection for Internet Protocol Version 6 (IPv6)" states that both IPv4 auto-configuration addresses (prefix 169.254/16) and IPv4 loopback addresses (prefix 127/8) have link-local scope, but Inet4Address only considers the auto-configuration addresses to have link-local scope. That is: the IPv4 loopback address returns false.

public boolean isLoopbackAddress ()

Added in API level 1

Returns whether this address is a loopback address or not.

Valid IPv4 loopback addresses have the prefix 127/8.

The only valid IPv6 loopback address is ::1.

public boolean isMCGlobal ()

Added in API level 1

Returns whether this address is a global multicast address or not.

Valid IPv6 global multicast addresses have the prefix ffxe::/16, where x is a set of flags and the additional 112 bits make up the global multicast address space.

Valid IPv4 global multicast addresses are the range of addresses from 224.0.1.0 to 238.255.255.255.

public boolean isMCLinkLocal ()

Added in API level 1

Returns whether this address is a link-local multicast address or not.

Valid IPv6 link-local multicast addresses have the prefix ffx2::/16, where x is a set of flags and the additional 112 bits make up the link-local multicast address space.

Valid IPv4 link-local multicast addresses have the prefix 224.0.0/24.

public boolean isMCNodeLocal ()

Added in API level 1

Returns whether this address is a node-local multicast address or not.

Valid IPv6 node-local multicast addresses have the prefix ffx1::/16, where x is a set of flags and the additional 112 bits make up the link-local multicast address space.

There are no valid IPv4 node-local multicast addresses.

public boolean isMCOrgLocal ()

Added in API level 1

Returns whether this address is a organization-local multicast address or not.

Valid IPv6 organization-local multicast addresses have the prefix ffx8::/16, where x is a set of flags and the additional 112 bits make up the link-local multicast address space.

Valid IPv4 organization-local multicast addresses have the prefix 239.192/14.

public boolean isMCSiteLocal ()

Added in API level 1

Returns whether this address is a site-local multicast address or not.

Valid IPv6 site-local multicast addresses have the prefix ffx5::/16, where x is a set of flags and the additional 112 bits make up the link-local multicast address space.

Valid IPv4 site-local multicast addresses have the prefix 239.255/16.

public boolean isMulticastAddress ()

Added in API level 1

Returns whether this address is a multicast address or not.

Valid IPv6 multicast addresses have the prefix ff::/8.

Valid IPv4 multicast addresses have the prefix 224/4.

public boolean isSiteLocalAddress ()

Added in API level 1

Returns whether this address is a site-local address or not.

For the purposes of this method, valid IPv6 site-local addresses have the deprecated prefix fec0::/10 from RFC 1884, not the modern prefix fc00::/7 from RFC 4193.

RFC 3484 "Default Address Selection for Internet Protocol Version 6 (IPv6)" states that IPv4 private addresses have the prefix 10/8, 172.16/12, or 192.168/16.

Returns

true if this instance represents a site-local address, false otherwise.

public String toString ()

Added in API level 1

Returns a string containing the host name (if available) and host address. For example: "www.google.com/74.125.224.115" or "/127.0.0.1".

IPv6 addresses may additionally include an interface name or scope id. For example: "www.google.com/2001:4860:4001:803::1013%eth0" or "/2001:4860:4001:803::1013%2".

Returns

a printable representation of this object.

information

No examples for this method.

Frequently called with: [Clear]

This example was provided by APIMiner.

Portions of this page are reproduced from work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. The original page is available here.

Results

Interfaces

Classes

Enums

Exceptions

Inet6Address

Class Overview

Summary

Public Methods

public static Inet6Address getByAddress (String host, byte[] addr, int scope_id)

Parameters

Returns

Throws

public static Inet6Address getByAddress (String host, byte[] addr, NetworkInterface nif)

Parameters

Returns

Throws

public int getScopeId ()

public NetworkInterface getScopedInterface ()

public boolean isAnyLocalAddress ()

public boolean isIPv4CompatibleAddress ()

public boolean isLinkLocalAddress ()

public boolean isLoopbackAddress ()

public boolean isMCGlobal ()

public boolean isMCLinkLocal ()

public boolean isMCNodeLocal ()

public boolean isMCOrgLocal ()

public boolean isMCSiteLocal ()

public boolean isMulticastAddress ()

public boolean isSiteLocalAddress ()

Returns

public String toString ()

Returns