リポジトリクエリの戻り値の型

サポートされているクエリの戻り値の型

次の表に、Spring Data リポジトリで一般的にサポートされる戻り値の型を示します。ただし、ここにリストされている一部の型は特定のストアでサポートされていない可能性があるため、サポートされる戻り値の型の正確なリストについてはストア固有のドキュメントを参照してください。

地理空間型（GeoResult、GeoResults、GeoPage など）は、地理空間クエリをサポートするデータストアでのみ使用できます。一部のストアモジュールは、独自の結果ラッパー型を定義する場合があります。

表 1: クエリの戻り型
戻りの型	説明
`void`	戻り値がないことを示します。
プリミティブ	Java プリミティブ。
ラッパーの種類	Java ラッパー型。
`T`	一意のエンティティ。クエリメソッドが最大で 1 つの結果を返すことを期待します。結果が見つからない場合、`null` が返されます。複数の結果が `IncorrectResultSizeDataAccessException` をトリガーします。
`Iterator<T>`	`Iterator`
`Collection<T>`	`Collection`
`List<T>`	`List`
`Optional<T>`	Java 8 または Guava `Optional` クエリメソッドが最大で 1 つの結果を返すことを期待します。結果が見つからない場合、`Optional.empty()` または `Optional.absent()` が返されます。複数の結果が `IncorrectResultSizeDataAccessException` をトリガーします。
`Option<T>`	Scala または Vavr `Option` 型のいずれか。前述の Java 8 の `Optional` と同じ意味の振る舞い。
`Stream<T>`	Java 8 `Stream`
`Streamable<T>`	`Iterable` の便利な拡張機能で、結果のストリーミング、マップ、フィルター、連結などを行うメソッドを直接公開します。
`Streamable` を実装し、`Streamable` コンストラクターまたはファクトリメソッド引数を取る型	`Streamable` を引数として取るコンストラクターまたは `… .of(…)`/ `… .valueOf(…)` ファクトリメソッドを公開する型。詳細については、カスタムのストリーミング可能なラッパー型を返すを参照してください。
Vavr `Seq`、`List`、`Map`、`Set`	Vavr コレクション型。詳細については、Vavr コレクションのサポートを参照してください。
`Future<T>`	`Future` メソッドに `@Async` のアノテーションが付けられることを期待し、Spring の非同期メソッド実行機能を有効にする必要があります。
`CompletableFuture<T>`	Java 8 `CompletableFuture` メソッドに `@Async` のアノテーションが付けられることを期待し、Spring の非同期メソッド実行機能を有効にする必要があります。
`Slice<T>`	使用可能なデータがさらにあるかどうかを示すサイズのデータチャンク。`Pageable` メソッドパラメーターが必要です。
`Page<T>`	結果の総数などの追加情報を含む `Slice`。`Pageable` メソッドパラメーターが必要です。
`Window<T>`	スクロールクエリから取得された結果の `Window`。次のスクロールクエリを発行するための `ScrollPosition` を提供します。`ScrollPosition` メソッドパラメーターが必要です。
`GeoResult<T>`	参照場所までの距離などの追加情報を含む結果エントリ。
`GeoResults<T>`	参照場所までの平均距離などの追加情報を含む `GeoResult<T>` のリスト。
`GeoPage<T>`	参照位置までの平均距離など、`Page` と `GeoResult<T>`。
`Mono<T>`	リアクティブリポジトリを使用して 0 個または 1 個の要素を放出するプロジェクト Reactor `Mono`。クエリメソッドが最大で 1 つの結果を返すことを期待します。結果が見つからない場合、`Mono.empty()` が返されます。複数の結果が `IncorrectResultSizeDataAccessException` をトリガーします。
`Flux<T>`	プロジェクト Reactor `Flux` は、リアクティブリポジトリを使用してゼロ、1 つ、多くの要素を放出します。`Flux` を返すクエリは、無限の数の要素も放出できます。
`Single<T>`	リアクティブリポジトリを使用して単一の要素を放出する RxJava `Single`。クエリメソッドが最大で 1 つの結果を返すことを期待します。結果が見つからない場合、`Mono.empty()` が返されます。複数の結果が `IncorrectResultSizeDataAccessException` をトリガーします。
`Maybe<T>`	リアクティブリポジトリを使用して 0 個または 1 個の要素を放出する RxJava `Maybe`。クエリメソッドが最大で 1 つの結果を返すことを期待します。結果が見つからない場合、`Mono.empty()` が返されます。複数の結果が `IncorrectResultSizeDataAccessException` をトリガーします。
`Flowable<T>`	リアクティブリポジトリを使用してゼロ、1 つ、多くの要素を放出する RxJava `Flowable`。`Flowable` を返すクエリは、無限の数の要素も放出できます。