インターフェース BeanDescriptor
- すべてのスーパーインターフェース:
ElementDescriptor
public interface BeanDescriptor extends ElementDescriptor
制約付き Java Bean とそれに関連する制約について説明します。この記述子のメソッドによって返されるすべてのオブジェクト(およびConstraintDescriptor
を含む関連オブジェクト)は不変です。- 作成者:
- Emmanuel Bernard, Gunnar Morling
ネストされたクラスのサマリー
インターフェース jakarta.validation.metadata.ElementDescriptor から継承されたネストクラス / インターフェース
ElementDescriptor.ConstraintFinder
メソッドのサマリー
すべてのメソッド インスタンスメソッド 抽象メソッド 修飾子と型 メソッド 説明 SetSE<ConstructorDescriptor>
getConstrainedConstructors()
この記述子で表される Bean の制約付きコンストラクターの記述子を含むセットを返します。SetSE<MethodDescriptor>
getConstrainedMethods(MethodType methodType, MethodType... methodTypes)
この記述子によって表される Bean の制約付きメソッドの記述子を含むセットを返します。SetSE<PropertyDescriptor>
getConstrainedProperties()
カスケードとして定義またはマークされた制約が少なくとも 1 つあるプロパティ記述子のセットを返します(Valid
)。ConstructorDescriptor
getConstraintsForConstructor(ClassSE<?>... parameterTypes)
指定されたコンストラクターのコンストラクター記述子を返します。MethodDescriptor
getConstraintsForMethod(StringSE methodName, ClassSE<?>... parameterTypes)
指定されたメソッドのメソッド記述子を返します。PropertyDescriptor
getConstraintsForProperty(StringSE propertyName)
指定されたプロパティのプロパティ記述子を返します。boolean
isBeanConstrained()
Bean に検証が含まれる場合、true
を返します。制約が Bean 自体でホストされているか、制約が Bean プロパティの 1 つでホストされているか、Bean プロパティがカスケード検証用にマークされている (Valid
)インターフェース jakarta.validation.metadata.ElementDescriptor から継承されたメソッド
findConstraints, getConstraintDescriptors, getElementClass, hasConstraints
メソッドの詳細
isBeanConstrained
boolean isBeanConstrained()
Bean に検証が含まれる場合、true
を返します。- 制約は Bean 自体でホストされます
- 制約は Bean プロパティの 1 つでホストされます
- または、Bean プロパティがカスケード検証用にマークされている (
Valid
)
制約のあるメソッドとコンストラクターは無視されます。
- 戻り値:
- Bean に検証が含まれる場合は
true
、それ以外の場合はfalse
getConstraintsForProperty
PropertyDescriptor getConstraintsForProperty(StringSE propertyName)
指定されたプロパティのプロパティ記述子を返します。プロパティが存在しないか、制約がなく、カスケードとしてマークされている場合は、
null
を返します(getConstrainedProperties()
を参照)。スーパー型のプロパティが考慮されます。- パラメーター:
propertyName
- 評価されたプロパティ- 戻り値:
- 特定のプロパティのプロパティ記述子
- 例外:
IllegalArgumentExceptionSE
-propertyName
がnull
の場合
getConstrainedProperties
SetSE<PropertyDescriptor> getConstrainedProperties()
カスケードとして定義またはマークされた制約が少なくとも 1 つあるプロパティ記述子のセットを返します(Valid
)。一致するプロパティがない場合は、空のセットが返されます。スーパー型のプロパティが考慮されます。
- 戻り値:
- 制約プロパティの
PropertyDescriptor
のセット。制約プロパティがない場合は、空のセットが返されます
getConstraintsForMethod
MethodDescriptor getConstraintsForMethod(StringSE methodName, ClassSE<?>... parameterTypes)
指定されたメソッドのメソッド記述子を返します。指定された名前とパラメーター型のメソッドが存在しない場合、または指定されたメソッドにパラメーターまたは戻り値の制約がなく、カスケード検証用にマークされたパラメーターまたは戻り値がない場合、
null
を返します。スーパー型の方法が考慮されます。- パラメーター:
methodName
- メソッドの名前parameterTypes
- メソッドのパラメーター型- 戻り値:
- 指定されたメソッドのメソッド記述子
- 例外:
IllegalArgumentExceptionSE
-methodName
がnull
の場合- 導入:
- 1.1
getConstrainedMethods
SetSE<MethodDescriptor> getConstrainedMethods(MethodType methodType, MethodType... methodTypes)
この記述子によって表される Bean の制約付きメソッドの記述子を含むセットを返します。制約付きメソッドには、カスケード検証用にマークされた少なくとも 1 つのパラメーターまたは戻り値制約または少なくとも 1 つのパラメーターまたは戻り値があります。スーパー型の方法が考慮されます。
指定されたメソッド型に一致するメソッドのみが考慮されます。
- パラメーター:
methodType
- 考慮すべきメソッド型methodTypes
- 考慮すべき残りのオプションのメソッド型- 戻り値:
- この Bean の制約されたメソッドの記述子を含むセット。この Bean に、考慮されるメソッド型の制約付きメソッドがないが、
null
がない場合は、空になります。 - 導入:
- 1.1
getConstraintsForConstructor
ConstructorDescriptor getConstraintsForConstructor(ClassSE<?>... parameterTypes)
指定されたコンストラクターのコンストラクター記述子を返します。指定されたパラメーター型のコンストラクターが存在しない場合、または指定されたコンストラクターにパラメーターまたは戻り値の制約がなく、カスケード検証用にマークされたパラメーターまたは戻り値がない場合、
null
を返します。- パラメーター:
parameterTypes
- コンストラクターのパラメーター型- 戻り値:
- 指定されたコンストラクターのコンストラクター記述子
- 導入:
- 1.1
getConstrainedConstructors
SetSE<ConstructorDescriptor> getConstrainedConstructors()
この記述子で表される Bean の制約付きコンストラクターの記述子を含むセットを返します。制約付きコンストラクターには、カスケード検証用にマークされた少なくとも 1 つのパラメーターまたは戻り値制約または少なくとも 1 つのパラメーターまたは戻り値があります。
- 戻り値:
- この Bean の制約付きコンストラクターの記述子を含むセット。この Bean に制約付きコンストラクターがないが、
null
がない場合は、空になります。 - 導入:
- 1.1