Home » openjdk-7 » java » net » [javadoc | source]
java.net
public final class: NetworkInterface [javadoc | source]
java.lang.Object
   java.net.NetworkInterface
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".
Constructor:
 NetworkInterface() 
 NetworkInterface(String name,
    int index,
    InetAddress[] addrs) 
Method from java.net.NetworkInterface Summary:
equals,   getByIndex,   getByInetAddress,   getByName,   getDisplayName,   getHardwareAddress,   getIndex,   getInetAddresses,   getInterfaceAddresses,   getMTU,   getName,   getNetworkInterfaces,   getParent,   getSubInterfaces,   hashCode,   isLoopback,   isPointToPoint,   isUp,   isVirtual,   supportsMulticast,   toString
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from java.net.NetworkInterface Detail:
 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.

 public static NetworkInterface getByIndex(int index) throws SocketException 
    Get a network interface given its index.
 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.

 public static NetworkInterface getByName(String name) throws SocketException 
    Searches for the network interface with the specified name.
 public String getDisplayName() 
    Get the display name of this network interface. A display name is a human readable String describing the network device.
 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. If a security manager is set, then the caller must have the permission NetPermission ("getNetworkInformation").
 public int getIndex() 
    Returns the index of this network interface. The index is an integer greater or equal to zero, or {@code -1} for unknown. This is a system specific value and interfaces with the same name can have different indexes on different machines.
 public Enumeration<InetAddress> 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. However, if the caller has the NetPermission ("getNetworkInformation") permission, then all InetAddresses are returned.

 public List<InterfaceAddress> 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.

 public int getMTU() throws SocketException 
    Returns the Maximum Transmission Unit (MTU) of this interface.
 public String getName() 
    Get the name of this network interface.
 public static Enumeration<NetworkInterface> 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
 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.
 public Enumeration<NetworkInterface> 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.

 public int hashCode() 
 public boolean isLoopback() throws SocketException 
    Returns whether a network interface is a loopback interface.
 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.
 public boolean isUp() throws SocketException 
    Returns whether a network interface is up and running.
 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.
 public boolean supportsMulticast() throws SocketException 
    Returns whether a network interface supports multicasting or not.
 public String toString()