Java : OptionalLong - API使用例
2024年02月05日
OptionalLong (Java SE 21 & JDK 21) の使用例まとめです。
だいたいのメソッドを網羅済みです。
API仕様書のおともにどうぞ。
概要
long値を含む場合と含まない場合があるコンテナオブジェクト。 値が存在する場合、isPresent()はtrueを返します。 値が存在しない場合、オブジェクトはemptyとみなされ、isPresent()はfalseを返します。
OptionalLong クラスは、プリミティブ型 の long を扱う Optional です。
関連記事 : Optionalの基本
本記事のコード例では、以下の LongSample クラスを使います。
public class LongSample {
private final long value;
public LongSample() {
this.value = -1;
}
public LongSample(long value) {
if (value < 0) {
throw new IllegalArgumentException();
}
this.value = value;
}
public OptionalLong getValue() {
if (value == -1) {
return OptionalLong.empty();
} else {
return OptionalLong.of(value);
}
}
}
final var sample = new LongSample(123);
sample.getValue().ifPresent(value -> {
System.out.println("value : " + value);
});
// 結果
// ↓
//value : 123
final var sample = new LongSample();
sample.getValue().ifPresentOrElse(value -> {
System.out.println("value : " + value);
}, () -> {
System.out.println("value : empty!");
});
// 結果
// ↓
//value : empty!
メソッド
static OptionalLong empty ()
空のOptionalLongインスタンスを返します。
final var opt = OptionalLong.empty();
System.out.println(opt); // OptionalLong.empty
System.out.println(opt.isEmpty()); // true
final var opt = OptionalLong.empty();
try {
final var value = opt.orElseThrow();
} catch (NoSuchElementException e) {
System.out.println(e);
}
// 結果
// ↓
//java.util.NoSuchElementException: No value present
boolean equals (Object obj)
他のオブジェクトがこのOptionalLongに"等しい"かどうかを示します。
final var opt1 = OptionalLong.of(100);
final var opt2 = OptionalLong.of(100);
final var opt3 = OptionalLong.of(999);
System.out.println(opt1.equals(opt2)); // true
System.out.println(opt1.equals(opt3)); // false
final var opt1 = OptionalLong.of(123);
final var opt2 = OptionalLong.empty();
System.out.println(opt1.equals(opt2)); // false
final var opt1 = OptionalLong.empty();
final var opt2 = OptionalLong.empty();
System.out.println(opt1.equals(opt2)); // true
long getAsLong ()
値がある場合は値を返し、そうでない場合はNoSuchElementExceptionをスローします。
final var sample = new LongSample(123);
final var opt = sample.getValue();
if (opt.isPresent()) {
System.out.println(opt.getAsLong()); // 123
}
final var sample = new LongSample();
final var opt = sample.getValue();
try {
final var value = opt.getAsLong();
} catch (NoSuchElementException e) {
System.out.println(e);
}
// 結果
// ↓
//java.util.NoSuchElementException: No value present
int hashCode ()
存在する場合は値のハッシュ・コードを返し、値が存在しない場合は0 (zero)を返します。
final var ret1 = OptionalLong.empty().hashCode();
System.out.println(ret1); // 0
final var ret2 = OptionalLong.of(123).hashCode();
System.out.println(ret2); // 123
final var ret3 = OptionalLong.of(-789).hashCode();
System.out.println(ret3); // 788
void ifPresent (LongConsumer action)
値が存在する場合は、その値で指定されたアクションを実行し、そうでない場合は何もしません。
final var sample = new LongSample(123);
System.out.println("-- ifPresent --");
sample.getValue().ifPresent(value -> {
System.out.println(" action : " + value);
});
System.out.println("-- end --");
// 結果
// ↓
//-- ifPresent --
// action : 123
//-- end --
final var sample = new LongSample();
System.out.println("-- ifPresent --");
sample.getValue().ifPresent(value -> {
System.out.println(" action : " + value);
});
System.out.println("-- end --");
// 結果
// ↓
//-- ifPresent --
//-- end --
void ifPresentOrElse (LongConsumer action, Runnable emptyAction)
値が存在する場合は、指定されたアクションを値とともに実行し、そうでない場合は空のベースのアクションを実行します。
final var sample = new LongSample(123);
System.out.println("-- ifPresentOrElse --");
sample.getValue().ifPresentOrElse(value -> {
System.out.println(" action : " + value);
}, () -> {
System.out.println(" emptyAction!");
});
System.out.println("-- end --");
// 結果
// ↓
//-- ifPresentOrElse --
// action : 123
//-- end --
final var sample = new LongSample();
System.out.println("-- ifPresentOrElse --");
sample.getValue().ifPresentOrElse(value -> {
System.out.println(" action : " + value);
}, () -> {
System.out.println(" emptyAction!");
});
System.out.println("-- end --");
// 結果
// ↓
//-- ifPresentOrElse --
// emptyAction!
//-- end --
boolean isEmpty ()
値が存在しない場合はtrue、それ以外の場合falseを返します。
final var sample = new LongSample(123);
if (sample.getValue().isEmpty()) {
System.out.println("empty!");
} else {
System.out.println("present!");
}
// 結果
// ↓
//present!
final var sample = new LongSample();
if (sample.getValue().isEmpty()) {
System.out.println("empty!");
} else {
System.out.println("present!");
}
// 結果
// ↓
//empty!
boolean isPresent ()
値が存在する場合はtrueを返し、そうでない場合はfalseを返します。
final var sample = new LongSample(123);
if (sample.getValue().isPresent()) {
System.out.println("present!");
} else {
System.out.println("empty!");
}
// 結果
// ↓
//present!
final var sample = new LongSample();
if (sample.getValue().isPresent()) {
System.out.println("present!");
} else {
System.out.println("empty!");
}
// 結果
// ↓
//empty!
static OptionalLong of (long value)
指定された値を記述するOptionalLongを返します。
final var opt1 = OptionalLong.of(123);
System.out.println(opt1); // OptionalLong[123]
final var opt2 = OptionalLong.of(-789);
System.out.println(opt2); // OptionalLong[-789]
long orElse (long other)
値が存在する場合は値を返し、そうでない場合はotherを返します。
final var sample = new LongSample(100);
final var ret = sample.getValue().orElse(9999);
System.out.println(ret); // 100
final var sample = new LongSample();
final var ret = sample.getValue().orElse(9999);
System.out.println(ret); // 9999
long orElseGet (LongSupplier supplier)
値が存在する場合は値を返し、そうでない場合は供給関数によって生成された結果を返します。
final var sample = new LongSample(100);
final var ret = sample.getValue().orElseGet(() -> {
System.out.println("action!");
return 9999;
});
System.out.println("ret = " + ret);
// 結果
// ↓
//ret = 100
final var sample = new LongSample();
final var ret = sample.getValue().orElseGet(() -> {
System.out.println("action!");
return 9999;
});
System.out.println("ret = " + ret);
// 結果
// ↓
//action!
//ret = 9999
long orElseThrow ()
値がある場合は値を返し、そうでない場合はNoSuchElementExceptionをスローします。
final var sample = new LongSample(123);
final var opt = sample.getValue();
if (opt.isPresent()) {
System.out.println(opt.orElseThrow()); // 123
}
final var sample = new LongSample();
final var opt = sample.getValue();
try {
final var value = opt.orElseThrow();
} catch (NoSuchElementException e) {
System.out.println(e);
}
// 結果
// ↓
//java.util.NoSuchElementException: No value present
<X extends Throwable> long orElseThrow (Supplier<? extends X> exceptionSupplier)
値が存在する場合は値を返し、そうでない場合は例外を提供する関数によって生成された例外をスローします。
final var sample = new LongSample(123);
final var opt = sample.getValue();
if (opt.isPresent()) {
final var value = opt.orElseThrow(IllegalStateException::new);
System.out.println(value); // 123
}
final var sample = new LongSample();
try {
final var value = sample.getValue().orElseThrow(() -> {
throw new IllegalStateException("empty!");
});
} catch (IllegalStateException e) {
System.out.println(e);
}
// 結果
// ↓
//java.lang.IllegalStateException: empty!
LongStream stream ()
値が存在する場合は、その値のみを含む順次LongStreamを返し、それ以外の場合は空のLongStreamを返します。
final var sample = new LongSample(123);
final var array = sample.getValue().stream().toArray();
System.out.println(Arrays.toString(array)); // [123]
final var count = sample.getValue().stream().count();
System.out.println(count); // 1
final var sample = new LongSample();
final var array = sample.getValue().stream().toArray();
System.out.println(Arrays.toString(array)); // []
final var count = sample.getValue().stream().count();
System.out.println(count); // 0
String toString ()
デバッグに適したこのOptionalLongの空でない文字列表現を返します。
final var ret1 = OptionalLong.empty().toString();
System.out.println(ret1); // OptionalLong.empty
final var ret2 = OptionalLong.of(123).toString();
System.out.println(ret2); // OptionalLong[123]
final var ret3 = OptionalLong.of(-789).toString();
System.out.println(ret3); // OptionalLong[-789]
関連記事
- API 使用例