java.net.NetworkInterface

public final class java.net

NetworkInterface

Java SE 6

This class represents a Network Interface made up of a name, and a list of IP addresses assigned to this interface. It is used to identify the local interface on which a multicast group is joined. Interfaces are normally known by names such as "le0".

since

1.4

Methods

public boolean

equals(Object obj)
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.

obj the object to compare against.

return true if the objects are the same; false otherwise.

See also getAddress()

public int

hashCode()

public boolean

supportsMulticast() throws SocketException
Returns whether a network interface supports multicasting or not.

return	`true` if the interface supports Multicasting.
Throws	SocketException: om ett I/O fel uppstår.
since	1.6

public String

toString()

Properties

public static NetworkInterface

getByInetAddress(InetAddress addr) throws SocketException
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.

addr The InetAddress to search with.

return A NetworkInterface or null if there is no network interface with the specified IP address.

Throws SocketException: If an I/O error occurs.

Throws NullPointerException: If the specified address is null.

public static NetworkInterface

getByName(String name) throws SocketException
Searches for the network interface with the specified name.

name	The name of the network interface.
return	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.
Throws	NullPointerException: If the specified name is `null`.

public String

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

return

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

public byte[]

getHardwareAddress() throws SocketException
Returns the hardware address (usually MAC) of the interface if it has one and if it can be accessed given the current privileges.

return	a byte array containing the address or `null` if the address doesn't exist or is not accessible.
Throws	SocketException: om ett I/O fel uppstår.
since	1.6

public Enumeration

getInetAddresses()
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.

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

public List

getInterfaceAddresses()
Get a List of all or a subset of the InterfaceAddresses of this network interface.

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

return a List object with all or a subset of the InterfaceAddresss of this network interface

since 1.6

public boolean

isLoopback() throws SocketException
Returns whether a network interface is a loopback interface.

return	`true` if the interface is a loopback interface.
Throws	SocketException: om ett I/O fel uppstår.
since	1.6

public int

getMTU() throws SocketException
Returns the Maximum Transmission Unit (MTU) of this interface.

return	the value of the MTU for that interface.
Throws	SocketException: om ett I/O fel uppstår.
since	1.6

public String

getName()
Get the name of this network interface.

return

the name of this network interface

public static Enumeration

getNetworkInterfaces() throws SocketException
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

return	an Enumeration of NetworkInterfaces found on this machine
Throws	SocketException: om ett I/O fel uppstår.

public NetworkInterface

getParent()
Returns the parent NetworkInterface of this interface if this is a subinterface, or null if it is a physical (non virtual) interface or has no parent.

return	The `NetworkInterface` this interface is attached to.
since	1.6

public boolean

isPointToPoint() throws SocketException
Returns whether a network interface is a point to point interface. A typical point to point interface would be a PPP connection through a modem.

return	`true` if the interface is a point to point interface.
Throws	SocketException: om ett I/O fel uppstår.
since	1.6

public Enumeration

getSubInterfaces()
Get an Enumeration with all the subinterfaces (also known as virtual interfaces) attached to this network interface.

For instance eth0:1 will be a subinterface to eth0.

return an Enumeration object with all of the subinterfaces of this network interface

since 1.6

public boolean

isUp() throws SocketException
Returns whether a network interface is up and running.

return	`true` if the interface is up and running.
Throws	SocketException: om ett I/O fel uppstår.
since	1.6

public boolean

isVirtual()
Returns whether this interface is a virtual interface (also called subinterface). Virtual interfaces are, on some systems, interfaces created as a child of a physical interface and given different settings (like address or MTU). Usually the name of the interface will the name of the parent followed by a colon (:) and a number identifying the child since there can be several virtual interfaces attached to a single physical interface.

return	`true` if this interface is a virtual interface.
since	1.6

About DocWeb · Bundles · Export · Export All

Top 10 · Statistics · Login

About Sun · Contact · Privacy · Terms of Use · Trademarks

Java SE 6