java.net
Class NetworkInterface

java.lang.Object
  |
  +--java.net.NetworkInterface

public final class NetworkInterface
extends Object

Untamed:


Field Summary
private  InetAddress[] addrs
           
private  String displayName
           
private  int index
           
private  String name
           
 
Constructor Summary
(package private) NetworkInterface()
          Returns an NetworkInterface object with index set to 0 and name to null.
(package private) NetworkInterface(String name, int index, InetAddress[] addrs)
           
 
Method Summary
 boolean equals(Object obj)
          Suppressed: Compares this object against the specified object.
private static NetworkInterface[] getAll()
           
(package private) static NetworkInterface getByIndex(int index)
          Get a network interface given its index.
static NetworkInterface getByInetAddress(InetAddress addr)
          Enabled: Convenience method to search for a network interface that has the specified Internet Protocol (IP) address bound to it.
private static NetworkInterface getByInetAddress0(InetAddress addr)
           
static NetworkInterface getByName(String name)
          Enabled: Searches for the network interface with the specified name.
private static NetworkInterface getByName0(String name)
           
 String getDisplayName()
          Enabled: Get the display name of this network interface.
(package private)  int getIndex()
          Get the index of this network interface.
 Enumeration getInetAddresses()
          Enabled: Convenience method to return an Enumeration with all or a subset of the InetAddresses bound to this network interface.
 String getName()
          Enabled: Get the name of this network interface.
static Enumeration getNetworkInterfaces()
          Enabled: Returns all the interfaces on this machine.
 int hashCode()
          Suppressed:
private static void init()
           
 String toString()
          Suppressed:
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

name

private String name

displayName

private String displayName

index

private int index

addrs

private InetAddress[] addrs
Constructor Detail

NetworkInterface

NetworkInterface()
Returns an NetworkInterface object with index set to 0 and name to null. Setting such an interface on a MulticastSocket will cause the kernel to choose one interface for sending multicast packets.


NetworkInterface

NetworkInterface(String name,
                 int index,
                 InetAddress[] addrs)
Method Detail

getName

public String getName()
Enabled: Get the name of this network interface.

Returns:
the name of this network interface

getInetAddresses

public Enumeration getInetAddresses()
Enabled: Convenience method to return an Enumeration with all or a subset of the InetAddresses bound to this network interface.

If there is a security manager, its checkConnect method is called for each InetAddress. Only InetAddresses where the checkConnect doesn't throw a SecurityException will be returned in the Enumeration.

Returns:
an Enumeration object with all or a subset of the InetAddresses bound to this network interface

getIndex

int getIndex()
Get the index of this network interface.

Returns:
the index of this network interface

getDisplayName

public String getDisplayName()
Enabled: Get the display name of this network interface. A display name is a human readable String describing the network device.

Returns:
the display name of this network interface, or null if no display name is available.

getByName

public static NetworkInterface getByName(String name)
                                  throws SocketException
Enabled: Searches for the network interface with the specified name.

Parameters:
name - The name of the network interface.
Returns:
A NetworkInterface with the specified name, or null if there is no network interface with the specified name.
Throws:
SocketException - If an I/O error occurs.
NullPointerException - If the specified name is null.

getByIndex

static NetworkInterface getByIndex(int index)
                            throws SocketException
Get a network interface given its index.

Parameters:
index - an integer, the index of the interface
Returns:
the NetworkInterface obtained from its index
SocketException

getByInetAddress

public static NetworkInterface getByInetAddress(InetAddress addr)
                                         throws SocketException
Enabled: Convenience method to search for a network interface that has the specified Internet Protocol (IP) address bound to it.

If the specified IP address is bound to multiple network interfaces it is not defined which network interface is returned.

Parameters:
addr - The InetAddress to search with.
Returns:
A NetworkInterface or null if there is no network interface with the specified IP address.
Throws:
SocketException - If an I/O error occurs.
NullPointerException - If the specified address is null.

getNetworkInterfaces

public static Enumeration getNetworkInterfaces()
                                        throws SocketException
Enabled: Returns all the interfaces on this machine. Returns null if no network interfaces could be found on this machine. NOTE: can use getNetworkInterfaces()+getInetAddresses() to obtain all IP addresses for this node

Returns:
an Enumeration of NetworkInterfaces found on this machine
SocketException

getAll

private static NetworkInterface[] getAll()
                                  throws SocketException
SocketException

getByName0

private static NetworkInterface getByName0(String name)
                                    throws SocketException
SocketException

getByInetAddress0

private static NetworkInterface getByInetAddress0(InetAddress addr)
                                           throws SocketException
SocketException

equals

public boolean equals(Object obj)
Suppressed: Compares this object against the specified object. The result is true if and only if the argument is not null and it represents the same NetworkInterface as this object.

Two instances of NetworkInterface represent the same NetworkInterface if both name and addrs are the same for both.

Overrides:
equals in class Object
Parameters:
obj - the object to compare against.
Returns:
true if the objects are the same; false otherwise.
See Also:
java.net.InetAddress#getAddress()

hashCode

public int hashCode()
Suppressed:

Overrides:
hashCode in class Object
Returns:
a hash code value for this object.
See Also:
java.lang.Object#equals(java.lang.Object), java.util.Hashtable

toString

public String toString()
Suppressed:

Overrides:
toString in class Object
Returns:
a string representation of the object.

init

private static void init()


comments?