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

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
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
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, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

equals

public boolean equals(Object obj)
Checks if the current instance is equal to obj
Overrides:
equals in interface Object
Parameters:
obj - The object to compare with
Returns:
true if equal, false otherwise

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

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

getDisplayName

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

getInetAddresses

public Enumeration 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 getNetworkInterfaces()
            throws SocketException
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
Overrides:
hashCode in interface Object
Returns:
the hashcode

toString

public String toString()
Returns a string representation of the interface
Overrides:
toString in interface Object
Returns:
the string

NetworkInterface.java -- Copyright (C) 2002, 2003, 2004, 2005 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.