Packages

c

com.twitter.util.validation.cfg

ConstraintMapping

case class ConstraintMapping(annotationType: Class[_ <: Annotation], constraintValidator: Class[_ <: ConstraintValidator[_ <: Annotation, _]], includeExistingValidators: Boolean = true) extends Product with Serializable

Simple configuration class for defining constraint mappings for ScalaValidator configuration.

Usage

val customConstraintMapping: ConstraintMapping =
  ConstraintMapping(classOf[Annotation], classOf[ConstraintValidator])

val validator: ScalaValidator =
  ScalaValidator.builder
    .withConstraintMapping(customConstraintMapping)
    .validator

or multiple mappings

val customConstraintMapping1: ConstraintMapping = ???
val customConstraintMapping2: ConstraintMapping = ???

val validator: ScalaValidator =
  ScalaValidator.builder
    .withConstraintMappings(Set(customConstraintMapping1, customConstraintMapping2))
    .validator
annotationType

the Class[Annotation] of the constraint annotation.

constraintValidator

the implementing ConstraintValidator class for the given constraint annotation.

includeExistingValidators

if this is an additional validator for the given constraint annotation type or if this should replace all existing validators for the given constraint annotation type. Default is true (additional).

Note

adding multiple constraint mappings for the same annotation type will result in a ValidationException being thrown.

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ConstraintMapping
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ConstraintMapping(annotationType: Class[_ <: Annotation], constraintValidator: Class[_ <: ConstraintValidator[_ <: Annotation, _]], includeExistingValidators: Boolean = true)

    annotationType

    the Class[Annotation] of the constraint annotation.

    constraintValidator

    the implementing ConstraintValidator class for the given constraint annotation.

    includeExistingValidators

    if this is an additional validator for the given constraint annotation type or if this should replace all existing validators for the given constraint annotation type. Default is true (additional).

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. val annotationType: Class[_ <: Annotation]
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  7. val constraintValidator: Class[_ <: ConstraintValidator[_ <: Annotation, _]]
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  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. val includeExistingValidators: Boolean
  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. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped