OptionalInt (Java Platform SE 8)

java.lang.Object
- java.util.OptionalInt

```
public final class OptionalInt
extends Object
```
int値が含まれている場合も含まれていない場合もあるコンテナ・オブジェクトです。値が存在する場合、isPresent()はtrueを返し、getAsInt()は値を返します。
含まれる値の有無に応じて追加メソッドが提供されます。たとえば、orElse() (値が存在しない場合にデフォルト値を返す)、ifPresent() (値が存在する場合にコードのブロックを実行する)など。
これは値ベースのクラスで、OptionalIntのインスタンスに対して、ID依存操作(参照等価性(==)、IDハッシュ・コード、同期など)を使用すると、予期できない結果になる可能性があり、避けてください。

導入されたバージョン:

1.8

メソッドのサマリー

すべてのメソッド staticメソッドインスタンス・メソッド具象メソッド
修飾子と型	メソッドと説明
`static OptionalInt`	`empty()` 空の`OptionalInt`インスタンスを返します。
`boolean`	`equals(Object obj)` このOptionalIntと他のオブジェクトが等しいかどうかを示します。
`int`	`getAsInt()` この`OptionalInt`に値が存在する場合は値を返します。それ以外の場合は`NoSuchElementException`をスローします。
`int`	`hashCode()` 存在する値のハッシュ・コード値(ある場合)を返し、値が存在しない場合は0 (ゼロ)を返します。
`void`	`ifPresent(IntConsumer consumer)` 値が存在する場合は指定されたコンシューマにその値を渡し、存在しない場合は何も行いません。
`boolean`	`isPresent()` 存在する値がある場合は`true`を返し、それ以外の場合は`false`を返します。
`static OptionalInt`	`of(int value)` 指定された値を含む`OptionalInt`を返します。
`int`	`orElse(int other)` 存在する場合は値を返し、それ以外の場合は`other`を返します。
`int`	`orElseGet(IntSupplier other)` 値が存在する場合はその値を返し、そうでない場合は`other`を呼び出し、その呼び出しの結果を返します。
`<X extends Throwable> int`	`orElseThrow(Supplier<X> exceptionSupplier)` 値が存在する場合は、その含まれている値を返し、それ以外の場合は、指定されたサプライヤによって作成された例外をスローします。
`String`	`toString()` オブジェクトの文字列表現を返します。

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

- メソッドの詳細
  - empty
```
public static OptionalInt empty()
```
    空のOptionalIntインスタンスを返します。このOptionalIntの値は存在しません。
    
    APIの注:
    
    Option.empty()で返されたインスタンスに対して==で比較することによってオブジェクトが空かどうかを判定しないでください(そうしたいかもしれませんが)。シングルトンである保証はありません。かわりにisPresent()を使用してください。
    
    戻り値:
    
    空のOptionalInt。
  - of
```
public static OptionalInt of(int value)
```
    指定された値を含むOptionalIntを返します。
    
    パラメータ:
    
    value - 存在する値
    
    戻り値:
    
    値が存在するOptionalInt
  - getAsInt
```
public int getAsInt()
```
    このOptionalIntに値が存在する場合は値を返します。それ以外の場合はNoSuchElementExceptionをスローします。
    
    戻り値:
    
    このOptionalIntが保持する値
    
    例外:
    
    NoSuchElementException - 存在する値がない場合
    
    関連項目:
    
    isPresent()
  - isPresent
```
public boolean isPresent()
```
    存在する値がある場合はtrueを返し、それ以外の場合はfalseを返します。
    
    戻り値:
    
    存在する値がない場合はtrue、それ以外の場合はfalse
  - ifPresent
```
public void ifPresent(IntConsumer consumer)
```
    値が存在する場合は指定されたコンシューマにその値を渡し、存在しない場合は何も行いません。
    
    パラメータ:
    
    consumer - 値が存在する場合に実行されるブロック
    
    例外:
    
    NullPointerException - 値が存在しconsumerがnullの場合
  - orElse
```
public int orElse(int other)
```
    存在する場合は値を返し、それ以外の場合はotherを返します。
    
    パラメータ:
    
    other - 存在する値がない場合に返される値
    
    戻り値:
    
    値(存在する場合)、それ以外の場合はother
  - orElseGet
```
public int orElseGet(IntSupplier other)
```
    値が存在する場合はその値を返し、そうでない場合はotherを呼び出し、その呼び出しの結果を返します。
    
    パラメータ:
    
    other - IntSupplier(値が存在しない場合は、これの結果が返される)
    
    戻り値:
    
    値(存在する場合)、それ以外の場合はother.getAsInt()の結果
    
    例外:
    
    NullPointerException - 値が存在せずotherがnullの場合
  - orElseThrow
```
public <X extends Throwable> int orElseThrow(Supplier<X> exceptionSupplier)
                                      throws X extends Throwable
```
    値が存在する場合は、その含まれている値を返し、それ以外の場合は、指定されたサプライヤによって作成された例外をスローします。
    
    APIの注:
    
    引数リストが空である例外コンストラクタへのメソッド参照をサプライヤとして使用できます。たとえば、IllegalStateException::newなどです。
    
    型パラメータ:
    
    X - スローされる例外の型
    
    パラメータ:
    
    exceptionSupplier - スローされる例外を返すサプライヤ
    
    戻り値:
    
    存在する値
    
    例外:
    
    X - 存在する値がない場合
    
    NullPointerException - 値が存在せずexceptionSupplierがnullの場合
    
    X extends Throwable
  - equals
```
public boolean equals(Object obj)
```
    このOptionalIntと他のオブジェクトが等しいかどうかを示します。他方のオブジェクトは次の場合に同等と見なされます。
    - それもOptionalIntである、および
    - 両方のインスタンスに存在する値がない、または
    - 存在する値が==によってお互いに等しい。
    オーバーライド:
    
    equals、クラス: Object
    
    パラメータ:
    
    obj - 等価性を判定されるオブジェクト
    
    戻り値:
    
    他方のオブジェクトがこのオブジェクトと等しい場合は{code true}、それ以外の場合はfalse
    
    関連項目:
    
    Object.hashCode(), HashMap
  - hashCode
```
public int hashCode()
```
    存在する値のハッシュ・コード値(ある場合)を返し、値が存在しない場合は0 (ゼロ)を返します。
    
    オーバーライド:
    
    hashCode、クラス: Object
    
    戻り値:
    
    存在する値のハッシュ・コード値、値が存在しない場合は0
    
    関連項目:
    
    Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)
  - toString
```
public String toString()
```
    オブジェクトの文字列表現を返します。一般に、toStringメソッドは、このオブジェクトを「テキストで表す」文字列を返します。この結果は、人間が読める簡潔で有益な情報であるべきです。すべてのサブクラスで、このメソッドをオーバーライドすることをお薦めします。
    クラスObjectのtoStringメソッドは、オブジェクトがインスタンスになっている元のクラスの名前、アットマーク文字「@」、およびオブジェクトのハッシュ・コードの符号なし16進数表現から構成される文字列を返します。つまり、このメソッドは次の値と等しい文字列を返します。
    getClass().getName() + '@' + Integer.toHexString(hashCode())
    デバッグに適しているこのオブジェクトの空ではない文字列表現を返します。正確な表示フォーマットは未指定であり、実装とバージョンの間で異なることがあります。
    オーバーライド:
    
    toString、クラス: Object
    
    実装要件:
    
    値が存在する場合は、結果にその文字列表現が含まれる必要があります。空および存在するインスタンスは明確に区別できる必要があります。
    
    戻り値:
    
    このインスタンスの文字列表現

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

クラスOptionalInt

メソッドのサマリー

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

メソッドの詳細

empty

of

getAsInt

isPresent

ifPresent

orElse

orElseGet

orElseThrow

equals

hashCode

toString