Packages

abstract class BaseValidator extends AnyRef

An interface to define APIs for default validations (depend on com.twitter.util.validation.ScalaValidator) and custom validations.

Linear Supertypes
AnyRef, Any
Known Subclasses
ThriftValidator
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BaseValidator
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new BaseValidator()

Abstract Value Members

  1. abstract def annotations: Set[String]

    All annotations defined in this validator.

  2. abstract def validateField[T](fieldName: String, fieldValue: T, fieldAnnotations: Map[String, String]): Set[ThriftValidationViolation]

    Validate a field value against its annotation.

    Validate a field value against its annotation.

    T

    The type of the field.

    fieldName

    The name of the field.

    fieldValue

    The value of the field to be validated.

    fieldAnnotations

    The annotation name and its value set on the field in Thrift IDL.

    returns

    A set of ThriftValidationViolations for violated constraints. Return an empty set if all validations passed.

    Note

    See a Java-friendly version of validateField that takes fieldAnnotations as a java.util.Map, and return a set of ThriftValidationViolations as java.util.Set.

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def annotationIsDefined(annotation: String): Boolean

    Check if a given annotation is already defined.

    Check if a given annotation is already defined.

    annotation

    the String annotation defined on IDL.

    returns

    true if the annotation is already defined.

  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  9. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  16. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  17. def toString(): String
    Definition Classes
    AnyRef → Any
  18. def validateField[T](fieldName: String, fieldValue: T, fieldAnnotations: Map[String, String]): Set[ThriftValidationViolation]

    A Java-friendly version of validateField, that takes fieldAnnotations as a java.util.Map, and return a set of ThriftValidationViolations as java.util.Set.

  19. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  21. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from AnyRef

Inherited from Any

Ungrouped