インターフェース ConstraintDescriptor<T extends AnnotationSE>
- 型パラメーター:
T- 制約のアノテーション型
public interface ConstraintDescriptor<T extends AnnotationSE>単一の制約とその構成制約について説明します。- 作成者:
- Emmanuel Bernard, Hardy Ferentschik
方法の概要
すべてのメソッド インスタンスメソッド 抽象メソッド 修飾子と型 メソッド 説明 TgetAnnotation()制約宣言を説明するアノテーションを返します。MapSE<StringSE,ObjectSE>getAttributes()キーとしてアノテーション属性名を含み、値としてアノテーション属性値を含むマップを返します。SetSE<ConstraintDescriptor<?>>getComposingConstraints()各記述子が構成制約を記述している構成ConstraintDescriptorのセットを返します。ListSE<ClassSE<? extends ConstraintValidator<T,?>>>getConstraintValidatorClasses()制約検証実装クラスのリスト。SetSE<ClassSE<?>>getGroups()制約が適用されるグループのセット。StringSEgetMessageTemplate()補間されていないエラーメッセージSetSE<ClassSE<? extends Payload>>getPayload()制約がホストするペイロードのセット。ConstraintTargetgetValidationAppliesTo()ValidateUnwrappedValuegetValueUnwrapping()booleanisReportAsSingleViolation()<U> Uunwrap(ClassSE<U> type)プロバイダー固有の API へのアクセスを許可する、指定された型のインスタンスを返します。
メソッドの詳細
getAnnotation
T getAnnotation()
制約宣言を説明するアノテーションを返します。構成制約の場合、属性値は構成制約のオーバーライドされた属性を反映しています- 戻り値:
- この制約のアノテーション
getMessageTemplate
StringSE getMessageTemplate()
補間されていないエラーメッセージ- 戻り値:
- 補間されていないエラーメッセージ
- 導入:
- 1.1
getGroups
SetSE<ClassSE<?>> getGroups()
制約が適用されるグループのセット。制約でグループが宣言されていない場合、Defaultグループのみのセットが返されます。- 戻り値:
- 制約が適用されるグループ
getPayload
SetSE<ClassSE<? extends Payload>> getPayload()
制約がホストするペイロードのセット。- 戻り値:
- 制約でホストされるペイロードクラス、またはない場合は空のセット
getValidationAppliesTo
ConstraintTarget getValidationAppliesTo()
- 戻り値:
ConstraintTarget値またはnull- 導入:
- 1.1
getConstraintValidatorClasses
ListSE<ClassSE<? extends ConstraintValidator<T,?>>> getConstraintValidatorClasses()
制約検証実装クラスのリスト。- 戻り値:
- 制約検証実装クラスのリスト
getAttributes
MapSE<StringSE,ObjectSE> getAttributes()
キーとしてアノテーション属性名を含み、値としてアノテーション属性値を含むマップを返します。この制約が構成された制約の一部として使用される場合、属性値は構成された制約のオーバーライドされた属性を反映しています。
- 戻り値:
- キーとしてのアノテーション属性名と値としてのアノテーション属性値を含むマップ
getComposingConstraints
SetSE<ConstraintDescriptor<?>> getComposingConstraints()
各記述子が構成制約を記述している構成ConstraintDescriptorのセットを返します。構成する制約のConstraintDescriptorインスタンスは、getAttributes()およびgetAnnotation()でオーバーライドされた属性値を反映します。- 戻り値:
ConstraintDescriptorオブジェクトのセット、または構成する制約がない場合は空のセット
isReportAsSingleViolation
boolean isReportAsSingleViolation()
- 戻り値:
true(制約にReportAsSingleViolationでアノテーションが付けられている場合)
getValueUnwrapping
ValidateUnwrappedValue getValueUnwrapping()
- 戻り値:
Unwrapping制約ペイロードを介して指定されたアンラップ動作を説明するValidateUnwrappedValue- 導入:
- 2.0
unwrap
<U> U unwrap(ClassSE<U> type)
プロバイダー固有の API へのアクセスを許可する、指定された型のインスタンスを返します。Jakarta Bean Validation プロバイダーの実装が指定されたクラスをサポートしない場合、
ValidationExceptionがスローされます。- 型パラメーター:
U- 返されるオブジェクトの型- パラメーター:
type- 返されるオブジェクトのクラス- 戻り値:
- 指定されたクラスのインスタンス
- 例外:
ValidationException- プロバイダーが呼び出しをサポートしていない場合- 導入:
- 2.0