java.net
Class NetworkInterface

java.lang.Object
  extended by java.net.NetworkInterface

public final class NetworkInterface
extends Object

This class models a network interface on the host computer. A network interface contains a name (typically associated with a specific hardware adapter) and a list of addresses that are bound to it. For example, an ethernet interface may be named "eth0" and have the address 192.168.1.101 assigned to it.

Since:
1.4

Method Summary
 boolean equals(Object obj)
          Checks if the current instance is equal to obj
static NetworkInterface getByInetAddress(InetAddress addr)
          Return a network interface by its address
static NetworkInterface getByName(String name)
          Returns an network interface by name
 String getDisplayName()
          Returns the display name of the interface
 Enumeration<InetAddress> getInetAddresses()
          Returns all available addresses of the network interface If a @see SecurityManager is available all addresses are checked with @see SecurityManager::checkConnect() if they are available.
 String getName()
          Returns the name of the network interface
static Enumeration<NetworkInterface> getNetworkInterfaces()
          Return an Enumeration of all available network interfaces
 int hashCode()
          Returns the hashcode of the current instance
 String toString()
          Returns a string representation of the interface
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Method Detail

getName

public String getName()
Returns the name of the network interface

Returns:
The name of the interface.

getInetAddresses

public Enumeration<InetAddress> getInetAddresses()
Returns all available addresses of the network interface If a @see SecurityManager is available all addresses are checked with @see SecurityManager::checkConnect() if they are available. Only InetAddresses are returned where the security manager doesn't throw an exception.

Returns:
An enumeration of all addresses.

getDisplayName

public String getDisplayName()
Returns the display name of the interface

Returns:
The display name of the interface

getByName

public static NetworkInterface getByName(String name)
                                  throws SocketException
Returns an network interface by name

Parameters:
name - The name of the interface to return
Returns:
a NetworkInterface object representing the interface, or null if there is no interface with that name.
Throws:
SocketException - If an error occurs
NullPointerException - If the specified name is null

getByInetAddress

public static NetworkInterface getByInetAddress(InetAddress addr)
                                         throws SocketException
Return a network interface by its address

Parameters:
addr - The address of the interface to return
Returns:
the interface, or null if none found
Throws:
SocketException - If an error occurs
NullPointerException - If the specified addess is null

getNetworkInterfaces

public static Enumeration<NetworkInterface> getNetworkInterfaces()
                                                          throws SocketException
Return an Enumeration of all available network interfaces

Returns:
all interfaces
Throws:
SocketException - If an error occurs

equals

public boolean equals(Object obj)
Checks if the current instance is equal to obj

Overrides:
equals in class Object
Parameters:
obj - The object to compare with
Returns:
true if equal, false otherwise
See Also:
Object.hashCode()

hashCode

public int hashCode()
Returns the hashcode of the current instance

Overrides:
hashCode in class Object
Returns:
the hashcode
See Also:
Object.equals(Object), System.identityHashCode(Object)

toString

public String toString()
Returns a string representation of the interface

Overrides:
toString in class Object
Returns:
the string
See Also:
Object.getClass(), Object.hashCode(), Class.getName(), Integer.toHexString(int)