java.net

Class 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
booleanequals(Object obj)
Checks if the current instance is equal to obj
static NetworkInterfacegetByInetAddress(InetAddress addr)
Return a network interface by its address
static NetworkInterfacegetByName(String name)
Returns an network interface by name
StringgetDisplayName()
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.
StringgetName()
Returns the name of the network interface
static Enumeration<NetworkInterface>getNetworkInterfaces()
Return an Enumeration of all available network interfaces
inthashCode()
Returns the hashcode of the current instance
booleanisLoopback()
Determines whether this interface is the loopback interface.
booleanisPointToPoint()
Determines whether this interface does point to point transmission.
booleanisUp()
Determines whether this interface is ready to transfer data.
booleansupportsMulticast()
Determines whether this interface supports multicast transmission.
StringtoString()
Returns a string representation of the interface

Method Detail

equals

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

Parameters: obj The object to compare with

Returns: true if equal, false otherwise

getByInetAddress

public static NetworkInterface getByInetAddress(InetAddress addr)
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

getByName

public static NetworkInterface getByName(String name)
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

getDisplayName

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

Returns: The display 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.

getName

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

Returns: The name of the interface.

getNetworkInterfaces

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

Returns: all interfaces

Throws: SocketException If an error occurs

hashCode

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

Returns: the hashcode

isLoopback

public boolean isLoopback()
Determines whether this interface is the loopback interface.

Returns: whether the interface is the loopback interface

isPointToPoint

public boolean isPointToPoint()
Determines whether this interface does point to point transmission.

Returns: whether the interface does point to point transmission

isUp

public boolean isUp()
Determines whether this interface is ready to transfer data.

Returns: whether the interface is up

supportsMulticast

public boolean supportsMulticast()
Determines whether this interface supports multicast transmission.

Returns: whether the interface supports multicast transmission.

toString

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

Returns: the string