com.nifty.cloud.sdk.annotation

注釈型 Query

@Retention(value=RUNTIME)
 @Target(value=METHOD)
public @interface Query

クエリ指定アノテーション。
このクラスは、リクエストクラスからのクエリ作成時に使用します。

必須要素のサマリー

必須要素

修飾子とタイプ	必須要素と説明
java.lang.String	name クエリで使用する名前を指定します。

任意要素のサマリー

任意要素

修飾子とタイプ	任意要素と説明
java.lang.String	alias 必須項目チェックでエラーとなった際、クエリ名以外の文字列を表示したい場合に指定します。
boolean	require 必須項目の場合、trueを設定します。
boolean	reverseSequence シーケンス番号を項目名の後ろにつける場合にtrueを設定します。

要素の詳細

name

public abstract java.lang.String name

クエリで使用する名前を指定します。 指定は引数の無いgetterメソッドに対し行います。

戻り値:

クエリ名

alias

public abstract java.lang.String alias

必須項目チェックでエラーとなった際、クエリ名以外の文字列を表示したい場合に指定します。

戻り値:

クエリ別名

デフォルト:

""

require

public abstract boolean require

必須項目の場合、trueを設定します。 Default値はfalse。

戻り値:

必須項目の場合true、非必須項目はfalse

デフォルト:

false

reverseSequence

public abstract boolean reverseSequence

シーケンス番号を項目名の後ろにつける場合にtrueを設定します。 Default値はfalse.(前にシーケンス番号が付与される。)
ex)
\@Query(name="name") -> parent.1.name
\@Query(name="name", reverseSequence) -> parent.name.1

戻り値:

シーケンス番号を後ろにつける場合true、それ以外はfalse

デフォルト:

false