Class Validator.Result

  • Enclosing class:
    Validator<T>

    public class Validator.Result
    extends java.lang.Object
    An instance of Result is returned from a Validator's validate method to indicate an invalid value.

    A Result can contain an error code and/or description. These values are for your own reporting purposes and are not used internally.

    • Constructor Summary

      Constructors 
      Constructor Description
      Result​(java.lang.Object errorCode, java.lang.String description)
      Creates a Result with the given error code and description.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getDescription()
      Returns a description of the validation result, which may be null.
      java.lang.Object getErrorCode()
      Returns the error code for the result, which may be null.
      java.lang.String toString()
      Returns a string representation of the Result.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • Result

        public Result​(java.lang.Object errorCode,
                      java.lang.String description)
        Creates a Result with the given error code and description.
        Parameters:
        errorCode - an error code for this Result, may be null
        description - a textual description of the Result, may be null
    • Method Detail

      • getErrorCode

        public java.lang.Object getErrorCode()
        Returns the error code for the result, which may be null.
        Returns:
        the error code
      • getDescription

        public java.lang.String getDescription()
        Returns a description of the validation result, which may be null.
        Returns:
        the description
      • toString

        public java.lang.String toString()
        Returns a string representation of the Result. This method is intended to be used for debugging purposes only, and the content and format of the returned string may vary between implementations. The returned string may be empty but may not be null.
        Overrides:
        toString in class java.lang.Object
        Returns:
        a string representation of this Result