javax.persistence

インタフェース Tuple

public interface Tuple

クエリーの結果タプルの要素を抽出するためのインタフェース。

導入されたバージョン:

Java Persistence 2.0

関連項目:

TupleElement

メソッドのサマリー

修飾子とタイプ	メソッドと説明
java.lang.Object	get(int i) 結果タプルの指定された位置の要素の値を取得します。
<X> X	get(int i, java.lang.Class<X> type) 結果タプルの指定された位置の要素の値を取得します。
java.lang.Object	get(java.lang.String alias) 指定されたエイリアスで割り当てられているタプル要素の値を取得します。
<X> X	get(java.lang.String alias, java.lang.Class<X> type) 指定されたエイリアスで割り当てられているタプル要素の値を取得します。
<X> X	get(TupleElement<X> tupleElement) 指定されたタプル要素の値を取得します。
java.util.List<TupleElement<?>>	getElements() タプル要素を返します。
java.lang.Object[]	toArray() 結果タプル要素の値を配列として返します。

メソッドの詳細

get

<X> X get(TupleElement<X> tupleElement)

指定されたタプル要素の値を取得します。

パラメータ:

tupleElement - タプル要素

戻り値:

タプル要素の値

例外:

java.lang.IllegalArgumentException - タプル要素がこのクエリーの結果タプル内の要素に対応しない場合

get

<X> X get(java.lang.String alias,
          java.lang.Class<X> type)

指定されたエイリアスで割り当てられているタプル要素の値を取得します。

パラメータ:

alias - タプル要素に割り当てられているエイリアス

type - タプル要素の型

戻り値:

タプル要素の値

例外:

java.lang.IllegalArgumentException - エイリアスがクエリーの結果タプル内の要素に対応しない場合、または指定された型に要素を割り当てることができない場合

get

java.lang.Object get(java.lang.String alias)

指定されたエイリアスで割り当てられているタプル要素の値を取得します。

パラメータ:

alias - タプル要素に割り当てられているエイリアス

戻り値:

タプル要素の値

例外:

java.lang.IllegalArgumentException - エイリアスがクエリーの結果タプル内の要素に対応しない場合

get

<X> X get(int i,
          java.lang.Class<X> type)

結果タプルの指定された位置の要素の値を取得します。 最初の位置は0です。

パラメータ:

i - 結果タプルの位置

type - タプル要素の型

戻り値:

タプル要素の値

例外:

java.lang.IllegalArgumentException - iが結果タプルの長さを超えた場合、または指定された型に要素を代入できない場合

get

java.lang.Object get(int i)

結果タプルの指定された位置の要素の値を取得します。 最初の位置は0です。

パラメータ:

i - 結果タプルの位置

戻り値:

タプル要素の値

例外:

java.lang.IllegalArgumentException - iが結果タプルの長さを超えた場合

toArray

java.lang.Object[] toArray()

結果タプル要素の値を配列として返します。

戻り値:

タプル要素の値

getElements

java.util.List<TupleElement<?>> getElements()

タプル要素を返します。

戻り値:

タプル要素