NetworkInterface (Java Platform SE 7)

java.lang.Object
- java.net.NetworkInterface

```
public final class NetworkInterface
extends Object
```
このクラスは、名前と、このインタフェースに割り当てられた一連の IP アドレスから成るネットワークインタフェースを表します。これは、マルチキャストグループへの参加に使用するローカルインタフェースを特定するのに使用されます。インタフェースは通常、「le0」などの名前で識別されます。

導入されたバージョン:

1.4

メソッドのサマリー

メソッド
修飾子と型	メソッドと説明
`boolean`	`equals(Object obj)` このオブジェクトと指定されたオブジェクトを比較します。
`static NetworkInterface`	`getByIndex(int index)` 指定されたインデックスのネットワークインタフェースを取得します。
`static NetworkInterface`	`getByInetAddress(InetAddress addr)` 指定されたインターネットプロトコル (IP) アドレスがバインドされているネットワークインタフェースを検索する簡易メソッド。
`static NetworkInterface`	`getByName(String name)` 指定された名前のネットワークインタフェースを検索します。
`String`	`getDisplayName()` このネットワークインタフェースの表示名を取得します。
`byte[]`	`getHardwareAddress()` インタフェースがハードウェアアドレス (通常は MAC) を持っており、そのアドレスに現在の特権を使ってアクセス可能である場合に、そのアドレスを返します。
`int`	`getIndex()` このネットワークインタフェースのインデックスを返します。
`Enumeration<InetAddress>`	`getInetAddresses()` このネットワークインタフェースにバインドされた InetAddresses のすべてまたはサブセットの列挙を返す便利なメソッドです。
`List<InterfaceAddress>`	`getInterfaceAddresses()` このネットワークインタフェースの `InterfaceAddresses` のすべてまたはサブセットのリストを取得します。
`int`	`getMTU()` このインタフェースの最大転送単位 (MTU) を返します。
`String`	`getName()` このネットワークインタフェースの名前を取得します。
`static Enumeration<NetworkInterface>`	`getNetworkInterfaces()` このマシン上のすべてのインタフェースを返します。
`NetworkInterface`	`getParent()` このインタフェースがサブインタフェースの場合はその親となる NetworkInterface を返し、このインタフェースが物理 (非仮想) インタフェースであるか親を持たない場合は `null` を返します。
`Enumeration<NetworkInterface>`	`getSubInterfaces()` このネットワークインタフェースに接続されたすべてのサブインタフェース (仮想インタフェースとも呼ばれる) を含む列挙を取得します。
`int`	`hashCode()` オブジェクトのハッシュコード値を返します。
`boolean`	`isLoopback()` ネットワークインタフェースがループバックインタフェースかどうかを返します。
`boolean`	`isPointToPoint()` ネットワークインタフェースがポイントツーポイントインタフェースかどうかを返します。
`boolean`	`isUp()` ネットワークインタフェースが起動し、動作しているかどうかを返します。
`boolean`	`isVirtual()` このインタフェースが仮想インタフェース (サブインタフェースとも呼ばれる) かどうかを返します。
`boolean`	`supportsMulticast()` ネットワークインタフェースがマルチキャストをサポートしているかどうかを返します。
`String`	`toString()` オブジェクトの文字列表現を返します。

クラス java.lang.Object から継承されたメソッド
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- メソッドの詳細
  - getName
```
public String getName()
```
    このネットワークインタフェースの名前を取得します。
    
    戻り値:
    このネットワークインタフェースの名前
  - getInetAddresses
```
public Enumeration<InetAddress> getInetAddresses()
```
    このネットワークインタフェースにバインドされた InetAddresses のすべてまたはサブセットの列挙を返す便利なメソッドです。
    セキュリティーマネージャーが存在する場合、InetAddress ごとにその checkConnect メソッドが呼び出されます。checkConnect が SecurityException をスローしない InetAddress だけが、列挙内に返されます。ただし、呼び出し元が NetPermission(「getNetworkInformation」) アクセス権を持っている場合は、すべての InetAddress が返されます。
    
    戻り値:
    このネットワークインタフェースにバインドされた InetAddresses のすべてまたはサブセットの列挙オブジェクト
  - getInterfaceAddresses
```
public List<InterfaceAddress> getInterfaceAddresses()
```
    このネットワークインタフェースの InterfaceAddresses のすべてまたはサブセットのリストを取得します。
    セキュリティーマネージャーが存在する場合、InterfaceAddress ごとに、InetAddress を指定してセキュリティーマネージャーの checkConnect メソッドが呼び出されます。checkConnect が SecurityException をスローしない InterfaceAddress だけが、リスト内に返されます。
    
    戻り値:
    このネットワークインタフェースの InterfaceAddress のすべてまたはサブセットの List オブジェクト
    導入されたバージョン:
    
    1.6
  - getSubInterfaces
```
public Enumeration<NetworkInterface> getSubInterfaces()
```
    このネットワークインタフェースに接続されたすべてのサブインタフェース (仮想インタフェースとも呼ばれる) を含む列挙を取得します。
    たとえば、eth0:1 は eth0 のサブインタフェースです。
    
    戻り値:
    このネットワークインタフェースのすべてのサブインタフェースを含む列挙型オブジェクト
    導入されたバージョン:
    
    1.6
  - getParent
```
public NetworkInterface getParent()
```
    このインタフェースがサブインタフェースの場合はその親となる NetworkInterface を返し、このインタフェースが物理 (非仮想) インタフェースであるか親を持たない場合は null を返します。
    
    戻り値:
    このインタフェースが接続されている NetworkInterface。
    導入されたバージョン:
    
    1.6
  - getIndex
```
public int getIndex()
```
    このネットワークインタフェースのインデックスを返します。インデックスは 0 以上の整数です。インデックスが不明な場合は -1 を返します。これはシステム固有の値で、同じ名前を持つインタフェースでも、マシンが異なるとインデックスが異なる可能性があります。
    
    戻り値:
    このネットワークインタフェースのインデックス。インデックスが不明な場合は -1
    導入されたバージョン:
    
    1.7
    
    関連項目:
    getByIndex(int)
  - getDisplayName
```
public String getDisplayName()
```
    このネットワークインタフェースの表示名を取得します。表示名とは、ネットワークデバイスを記述した、人間が読むことのできる String のことです。
    
    戻り値:
    このネットワークインタフェースの表示名を表す空でない文字列。表示名が取得できない場合は null。
  - getByName
```
public static NetworkInterface getByName(String name)
                                  throws SocketException
```
    指定された名前のネットワークインタフェースを検索します。
    
    パラメータ:
    name − ネットワークインタフェースの名前。
    
    戻り値:
    指定された名前を持つ NetworkInterface。指定された名前のネットワークインタフェースが存在しない場合は null。
    
    例外:
    
    SocketException - 入出力エラーが発生した場合。
    
    NullPointerException − 指定された名前が null の場合。
  - getByIndex
```
public static NetworkInterface getByIndex(int index)
                                   throws SocketException
```
    指定されたインデックスのネットワークインタフェースを取得します。
    
    パラメータ:
    index - 整数。インタフェースのインデックス
    
    戻り値:
    インデックスから取得された NetworkInterface。システムにそうしたインデックスを持つインタフェースがない場合は null
    
    例外:
    
    SocketException - 入出力エラーが発生した場合。
    
    IllegalArgumentException - インデックスが負の値の場合
    導入されたバージョン:
    
    1.7
    
    関連項目:
    getIndex()
  - getByInetAddress
```
public static NetworkInterface getByInetAddress(InetAddress addr)
                                         throws SocketException
```
    指定されたインターネットプロトコル (IP) アドレスがバインドされているネットワークインタフェースを検索する簡易メソッド。
    指定された IP アドレスが複数のネットワークインタフェースにバインドされている場合、どのネットワークインタフェースが返されるかは未定義となります。
    
    パラメータ:
    addr − 検索に使用する InetAddress。
    
    戻り値:
    NetworkInterface。指定された IP アドレスを持つネットワークインタフェースが存在しない場合は null。
    
    例外:
    
    SocketException - 入出力エラーが発生した場合。
    
    NullPointerException − 指定されたアドレスが null の場合。
  - getNetworkInterfaces
```
public static Enumeration<NetworkInterface> getNetworkInterfaces()
                                                          throws SocketException
```
    このマシン上のすべてのインタフェースを返します。このマシン上でネットワークインタフェースが 1 つも見つからなかった場合は、null を返します。注: getNetworkInterfaces() と getInetAddresses() を使用して、このノードのすべての IP アドレスを取得できます。
    
    戻り値:
    このマシンで見つかった NetworkInterfaces の列挙
    
    例外:
    
    SocketException - 入出力エラーが発生した場合。
  - isUp
```
public boolean isUp()
             throws SocketException
```
    ネットワークインタフェースが起動し、動作しているかどうかを返します。
    
    戻り値:
    インタフェースが起動し、動作している場合は true。
    
    例外:
    
    SocketException - 入出力エラーが発生した場合。
    導入されたバージョン:
    
    1.6
  - isLoopback
```
public boolean isLoopback()
                   throws SocketException
```
    ネットワークインタフェースがループバックインタフェースかどうかを返します。
    
    戻り値:
    インタフェースがループバックインタフェースである場合は true。
    
    例外:
    
    SocketException - 入出力エラーが発生した場合。
    導入されたバージョン:
    
    1.6
  - isPointToPoint
```
public boolean isPointToPoint()
                       throws SocketException
```
    ネットワークインタフェースがポイントツーポイントインタフェースかどうかを返します。通常のポイントツーポイントインタフェースとして、モデム経由の PPP 接続が挙げられます。
    
    戻り値:
    インタフェースがポイントツーポイントインタフェースである場合は true。
    
    例外:
    
    SocketException - 入出力エラーが発生した場合。
    導入されたバージョン:
    
    1.6
  - supportsMulticast
```
public boolean supportsMulticast()
                          throws SocketException
```
    ネットワークインタフェースがマルチキャストをサポートしているかどうかを返します。
    
    戻り値:
    インタフェースがマルチキャストをサポートしている場合は true。
    
    例外:
    
    SocketException - 入出力エラーが発生した場合。
    導入されたバージョン:
    
    1.6
  - getHardwareAddress
```
public byte[] getHardwareAddress()
                          throws SocketException
```
    インタフェースがハードウェアアドレス (通常は MAC) を持っており、そのアドレスに現在の特権を使ってアクセス可能である場合に、そのアドレスを返します。セキュリティマネージャーが設定されている場合は、呼び出し元がアクセス権 NetPermission(「getNetworkInformation」) を持っている必要があります。
    
    戻り値:
    アドレスが格納されているバイト配列。アドレスが存在しない場合、アドレスにアクセスできない場合、またはセキュリティマネージャーが設定されている場合は、呼び出し元がアクセス権 NetPermission (「getNetworkInformation」) を持っていなければ null
    
    例外:
    
    SocketException - 入出力エラーが発生した場合。
    導入されたバージョン:
    
    1.6
  - getMTU
```
public int getMTU()
           throws SocketException
```
    このインタフェースの最大転送単位 (MTU) を返します。
    
    戻り値:
    そのインタフェースの MTU の値。
    
    例外:
    
    SocketException - 入出力エラーが発生した場合。
    導入されたバージョン:
    
    1.6
  - isVirtual
```
public boolean isVirtual()
```
    このインタフェースが仮想インタフェース (サブインタフェースとも呼ばれる) かどうかを返します。仮想インタフェースはシステムによっては、ある物理インタフェースの子として作成され、異なる設定 (アドレスや MTU など) が与えられたインタフェースになります。通常、このインタフェースの名前は、親の名前のあとに、コロン (:) と子を識別するための数字を付加したものになります。これは、単一の物理インタフェースに複数の仮想インタフェースが接続される可能性があるためです。
    
    戻り値:
    このインタフェースが仮想インタフェースである場合は true。
    導入されたバージョン:
    
    1.6
  - equals
```
public boolean equals(Object obj)
```
    このオブジェクトと指定されたオブジェクトを比較します。引数が null ではなく、その引数がこのオブジェクトと同じ NetworkInterface を表す場合にだけ、結果が true になります。
    名前とアドレスが両方とも同じ場合、NetworkInterface の 2 つのインスタンスは同じ NetworkInterface を表します。
    
    オーバーライド:
    
    equals、クラス: Object
    
    パラメータ:
    obj - 比較対象のオブジェクト。
    
    戻り値:
    オブジェクトが同じである場合は true、そうでない場合は false。
    関連項目:
    InetAddress.getAddress()
  - hashCode
```
public int hashCode()
```
    次のクラスからコピーされた説明: Object
    オブジェクトのハッシュコード値を返します。このメソッドは、HashMap によって提供されるハッシュテーブルなどの、ハッシュテーブルの利点のためにサポートされています。
    hashCode の一般的な規則は次のとおりです。
    - Java アプリケーションの実行中に同じオブジェクトに対して複数回呼び出された場合は常に、このオブジェクトに対する equals の比較で使用される情報が変更されていなければ、hashCode メソッドは常に同じ整数を返す必要があります。ただし、この整数は同じアプリケーションの実行ごとに同じである必要はありません。
    - equals(Object) メソッドに従って 2 つのオブジェクトが等しい場合は、2 つの各オブジェクトに対する hashCode メソッドの呼び出しによって同じ整数の結果が生成される必要があります。
    - Object.equals(java.lang.Object) メソッドに従って 2 つのオブジェクトが等しくない場合は、2 つの各オブジェクトに対する hashCode メソッドの呼び出しによって異なる整数の結果が生成される必要はありません。ただし、プログラマは、等しくないオブジェクトに対して異なる整数の結果を生成すると、ハッシュテーブルのパフォーマンスが向上する可能性があることに注意するようにしてください。
    クラス Object によって定義された hashCode メソッドは、可能なかぎり、異なるオブジェクトに対して異なる整数を返します。(これは通常、オブジェクトの内部アドレスを整数に変換することによって実装されますが、この実装テクニックは Java^TM プログラミング言語では必要ありません。)
    オーバーライド:
    
    hashCode、クラス: Object
    
    戻り値:
    このオブジェクトのハッシュコード値。
    関連項目:
    Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)
  - toString
```
public String toString()
```
    次のクラスからコピーされた説明: Object
    オブジェクトの文字列表現を返します。一般に、toString メソッドは、このオブジェクトを「テキストで表す」文字列を返します。この結果は、人間が読める簡潔で有益な情報であるべきです。すべてのサブクラスで、このメソッドをオーバーライドすることをお勧めします。
    クラス Object の toString メソッドは、オブジェクトがインスタンスになっている元のクラスの名前、アットマーク文字「@」、およびオブジェクトのハッシュコードの符号なし 16 進数表現から構成される文字列を返します。つまり、このメソッドは次の値と等しい文字列を返します。
    getClass().getName() + '@' + Integer.toHexString(hashCode())
    オーバーライド:
    
    toString、クラス: Object
    
    戻り値:
    このオブジェクトの文字列表現。

バグまたは機能を送信
詳細な API リファレンスおよび開発者ドキュメントについては、Java SE のドキュメントを参照してください。そのドキュメントには、概念的な概要、用語の定義、回避方法、有効なコード例などの、開発者を対象にしたより詳細な説明が含まれています。
Copyright © 1993, 2013, Oracle and/or its affiliates. All rights reserved.

クラス NetworkInterface

メソッドのサマリー

クラス java.lang.Object から継承されたメソッド

メソッドの詳細

getName

getInetAddresses

getInterfaceAddresses

getSubInterfaces

getParent

getIndex

getDisplayName

getByName

getByIndex

getByInetAddress

getNetworkInterfaces

isUp

isLoopback

isPointToPoint

supportsMulticast

getHardwareAddress

getMTU

isVirtual

equals

hashCode

toString