パッケージ jakarta.validation

インターフェース ConstraintViolation<T>

  • 型パラメーター:
    T - ルート Bean の型 
    public interface ConstraintViolation<T>
    制約違反について説明します。このオブジェクトは、制約違反コンテキストと違反を説明するメッセージを公開します。
    作成者:
    Emmanuel Bernard

    • 方法の概要

      すべてのメソッド   インスタンスメソッド   抽象メソッド  
      修飾子と型 メソッド 説明
      ConstraintDescriptor<?>getConstraintDescriptor()
      失敗すると報告された制約メタデータを返します。
      ObjectSE[]getExecutableParameters()
      メソッドまたはコンストラクターのパラメーターを検証した後に ConstraintViolation が返される場合、コンストラクターまたはメソッド呼び出し引数を表す Object[] を返します。
      ObjectSEgetExecutableReturnValue()
      メソッドまたはコンストラクターの戻り値を検証した後に ConstraintViolation が返される場合、コンストラクターまたはメソッド呼び出しの戻り値を返します。
      ObjectSEgetInvalidValue()
      制約に合格しない値を返します。
      ObjectSEgetLeafBean()
      戻り値: Bean 制約の場合、制約が適用される Bean インスタンス、Validator.validateValue(Class, String, Object, Class[]) を呼び出した後に ConstraintViolation が返されたときに、null プロパティでホストされるプロパティ制約またはコンテナー要素制約の場合、制約が適用されるプロパティをホストする Bean インスタンスオブジェクトがメソッドパラメーター、クロスパラメーターまたは戻り値の制約、メソッドパラメーターでホストされるコンテナー要素の制約である場合、メソッドが実行されるオブジェクト、コンストラクターパラメーターまたはクロスパラメーターの制約またはコンテナー要素の制約である場合、戻り値 null コンストラクターパラメーターでホストされるコンストラクターが値を返すコンストラクターである場合、コンストラクターが作成したオブジェクト
      StringSEgetMessage()
      StringSEgetMessageTemplate()
      PathgetPropertyPath()
      TgetRootBean()
      検証されているルート Bean を返します。
      ClassSE<T>getRootBeanClass()
      検証されているルート Bean のクラスを返します。
      <U> Uunwrap​(ClassSE<U> type)
      プロバイダー固有の API へのアクセスを許可する、指定された型のインスタンスを返します。

    • メソッドの詳細

      • getMessage

        StringSE getMessage()
        戻り値:
        この制約違反の補間エラーメッセージ

      • getMessageTemplate

        StringSE getMessageTemplate()
        戻り値:
        この制約違反の非補間エラーメッセージ

      • getRootBean

        T getRootBean()
        検証されているルート Bean を返します。メソッド検証の場合、メソッドが実行されるオブジェクトを返します。

        次の場合に null を返します。

        戻り値:
        検証済みオブジェクト、検証済み要素または null をホストするオブジェクト

      • getRootBeanClass

        ClassSE<T> getRootBeanClass()
        検証されているルート Bean のクラスを返します。メソッド検証の場合、これはメソッドが実行されるオブジェクトクラスです。コンストラクター検証の場合、これはコンストラクターが宣言されているクラスです。
        戻り値:
        ルート Bean または検証済み要素をホストするオブジェクトのクラス

      • getLeafBean

        ObjectSE getLeafBean()
        戻り値:
        • Bean 制約の場合、制約が適用される Bean インスタンス
        • 制約がプロパティでホストされている場合、またはプロパティでホストされているコンテナー要素の制約である場合、制約が適用されるプロパティをホストする Bean インスタンス
        • Validator.validateValue(Class, String, Object, Class[]) を呼び出した後に ConstraintViolation が返される場合の null 
        • メソッドパラメーター、クロスパラメーターまたは戻り値の制約、メソッドパラメーターまたは戻り値でホストされるコンテナー要素の制約である場合、メソッドが実行されるオブジェクト
        • null （コンストラクターパラメーター、クロスパラメーター制約、コンストラクターパラメーターでホストされるコンテナー要素制約の場合）
        • コンストラクターが戻り値の制約である場合、コンストラクターが作成したオブジェクト
        戻り値:
        葉 Bean

      • getExecutableParameters

        ObjectSE[] getExecutableParameters()
        メソッドまたはコンストラクターのパラメーターを検証した後に ConstraintViolation が返される場合、コンストラクターまたはメソッド呼び出し引数を表す Object[] を返します。それ以外の場合は、null を返します。
        戻り値:
        メソッドまたはコンストラクター呼び出しまたは null のパラメーター
        導入:
        1.1

      • getExecutableReturnValue

        ObjectSE getExecutableReturnValue()
        メソッドまたはコンストラクターの戻り値を検証した後に ConstraintViolation が返される場合、コンストラクターまたはメソッド呼び出しの戻り値を返します。

        メソッドに戻り値がない場合は、null を返します。それ以外の場合は、null を返します。

        戻り値:
        メソッドまたはコンストラクターの戻り値または null
        導入:
        1.1

      • getPropertyPath

        Path getPropertyPath()
        戻り値:
        rootBean からの値へのプロパティパス

      • getInvalidValue

        ObjectSE getInvalidValue()
        制約に合格しない値を返します。クロスパラメーター制約の場合、メソッド呼び出し引数を表す Object[] が返されます。
        戻り値:
        制約に合格しない値

      • getConstraintDescriptor

        ConstraintDescriptor<?> getConstraintDescriptor()
        失敗すると報告された制約メタデータを返します。返されるインスタンスは不変です。
        戻り値:
        制約メタデータ

      • unwrap

        <U> U unwrap​(ClassSE<U> type)
        プロバイダー固有の API へのアクセスを許可する、指定された型のインスタンスを返します。Jakarta Bean Validation プロバイダーの実装が指定されたクラスをサポートしない場合、ValidationException がスローされます。
        型パラメーター:
        U - 返されるオブジェクトの型
        パラメーター:
        type - 返されるオブジェクトのクラス
        戻り値:
        指定されたクラスのインスタンス
        例外:
        ValidationException - プロバイダーが呼び出しをサポートしていない場合
        導入:
        1.1