com.twitter.scrooge.thrift_validation

ThriftValidator

abstract class ThriftValidator extends BaseValidator

Implement this class to define a validator with custom validations.

Linear Supertypes
BaseValidator, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. ThriftValidator
  2. BaseValidator
  3. AnyRef
  4. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ThriftValidator()

Abstract Value Members

  1. abstract def customAnnotations: Map[String, ThriftConstraintValidator[_, _]]

    A map of String annotations to ThriftConstraintValidator.

    A map of String annotations to ThriftConstraintValidator.

    Note

    There is a Java helper toScalaMap, which takes a java.util.Map and return a scala.collection.immutable.Map for customAnnotations.

    ,

    Must override this method to define all custom validations in an implementation of ThriftValidator.

Concrete Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  6. 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.

    Definition Classes
    BaseValidator
  7. def annotations: Set[String]

    All custom annotations defined in this validator.

    All custom annotations defined in this validator.

    Definition Classes
    ThriftValidatorBaseValidator
  8. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  9. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  11. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  12. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  13. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  14. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  15. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  16. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  17. final def notify(): Unit

    Definition Classes
    AnyRef
  18. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  19. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  20. final def toScalaMap(javaMap: Map[String, ThriftConstraintValidator[_, _]]): Map[String, ThriftConstraintValidator[_, _]]

    A helper method that converts a java.util.Map to a scala.collection.immutable.Map

    A helper method that converts a java.util.Map to a scala.collection.immutable.Map

    Attributes
    protected
  21. def toString(): String

    Definition Classes
    AnyRef → Any
  22. 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.

    Definition Classes
    ThriftValidatorBaseValidator
    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 in BaseValidator.validateField().

  23. 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.

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

    Definition Classes
    BaseValidator
  24. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from BaseValidator

Inherited from AnyRef

Inherited from Any

Ungrouped