Parameters

Abstract Value Members

abstract def apply[T](spec: ParameterSpec[T], name: String, description: String = null): P[T] with R[T]

Create a parameter of a custom type.
Create a parameter of a custom type. This will hook into pre-request validation (in terms of optional/mandatory parameters)
T
the type of the parameter
spec
the parameter spec
name
the parameter name
description
the parameter description
returns
a parameter for retrieving a value of type [T] from the request

Concrete Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

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

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def bigDecimal(name: String, description: String = null): P[BigDecimal] with R[BigDecimal]

Create a BigDecimal parameter which is constrained to numeric values
Create a BigDecimal parameter which is constrained to numeric values
name
the name of the parameter (for use in description endpoints)
description
optional description of the parameter (for use in description endpoints)
returns
a parameter for retrieving a BigDecimal value from the request
def boolean(name: String, description: String = null): P[Boolean] with R[Boolean]

Create a Boolean parameter which is constrained to boolean values
Create a Boolean parameter which is constrained to boolean values
name
the name of the parameter (for use in description endpoints)
description
optional description of the parameter (for use in description endpoints)
returns
a parameter for retrieving a Boolean value from the request
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def dateTime(name: String, description: String = null): P[LocalDateTime] with R[LocalDateTime]

Create a LocalDateTime parameter which is constrained by the format YYYY-MM-DDTHH:mm:SS
Create a LocalDateTime parameter which is constrained by the format YYYY-MM-DDTHH:mm:SS
name
the name of the parameter (for use in description endpoints)
description
optional description of the parameter (for use in description endpoints)
returns
a parameter for retrieving a LocalDateTime value from the request
final def eq(arg0: AnyRef): Boolean

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

Definition Classes
AnyRef → Any
def finalize(): Unit

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

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
def int(name: String, description: String = null): P[Int] with R[Int]

Create a Scala Int parameter which is constrained to numeric Int values
Create a Scala Int parameter which is constrained to numeric Int values
name
the name of the parameter (for use in description endpoints)
description
optional description of the parameter (for use in description endpoints)
returns
a parameter for retrieving a Int value from the request
def integer(name: String, description: String = null): P[Integer] with R[Integer]

Create a Java Integer parameter which is constrained to numeric Integer values
Create a Java Integer parameter which is constrained to numeric Integer values
name
the name of the parameter (for use in description endpoints)
description
optional description of the parameter (for use in description endpoints)
returns
a parameter for retrieving a Integer value from the request
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def json[T](name: String, description: String = null, jsonLib: JsonLibrary[T, _] = Argo): P[T] with R[T]

Create a Json-format JsonNode parameter which is constrained to values which parse to valid JSON objects
Create a Json-format JsonNode parameter which is constrained to values which parse to valid JSON objects
name
the name of the parameter (for use in description endpoints)
description
optional description of the parameter (for use in description endpoints)
returns
a parameter for retrieving a JsonNode value from the request
def localDate(name: String, description: String = null): P[LocalDate] with R[LocalDate]

Create a LocalDate parameter which is constrained by the format YYYY-MM-DD
Create a LocalDate parameter which is constrained by the format YYYY-MM-DD
name
the name of the parameter (for use in description endpoints)
description
optional description of the parameter (for use in description endpoints)
returns
a parameter for retrieving a LocalDate value from the request
def long(name: String, description: String = null): P[Long] with R[Long]

Create a Long parameter which is constrained to numeric Long values
Create a Long parameter which is constrained to numeric Long values
name
the name of the parameter (for use in description endpoints)
description
optional description of the parameter (for use in description endpoints)
returns
a parameter for retrieving a Long value from the request
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def string(name: String, description: String = null, validation: StringValidations.Rule = StringValidations.EmptyIsInvalid): P[String] with R[String]

Create a String parameter which is not constrained
Create a String parameter which is not constrained
name
the name of the parameter (for use in description endpoints)
description
optional description of the parameter (for use in description endpoints)
validation
validation mode for String values
returns
a parameter for retrieving a String value from the request
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
def uuid(name: String, description: String = null): P[UUID] with R[UUID]

Create a UUID parameter
Create a UUID parameter
name
the name of the parameter (for use in description endpoints)
description
optional description of the parameter (for use in description endpoints)
returns
a parameter for retrieving a UUID value from the request
final def wait(): Unit

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )
def xml(name: String, description: String = null): P[Elem] with R[Elem]

Create a native Scala XML-format parameter which is constrained to values which parse to valid XML objects
Create a native Scala XML-format parameter which is constrained to values which parse to valid XML objects
name
the name of the parameter (for use in description endpoints)
description
optional description of the parameter (for use in description endpoints)
returns
a parameter for retrieving a JsonNode value from the request
def zonedDateTime(name: String, description: String = null): P[ZonedDateTime] with R[ZonedDateTime]

Create a ZonedDateTime parameter which is constrained by the format YYYY-MM-DDTHH:mm:SSZ (See DateTimeFormatter.ISO_OFFSET_DATE_TIME)
Create a ZonedDateTime parameter which is constrained by the format YYYY-MM-DDTHH:mm:SSZ (See DateTimeFormatter.ISO_OFFSET_DATE_TIME)
name
the name of the parameter (for use in description endpoints)
description
optional description of the parameter (for use in description endpoints)
returns
a parameter for retrieving a ZonedDateTime value from the request

Related Doc: package parameters

trait Parameters[P[_], R[_]] extends AnyRef

Abstract Value Members

abstract def apply[T](spec: ParameterSpec[T], name: String, description: String = null): P[T] with R[T]

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def bigDecimal(name: String, description: String = null): P[BigDecimal] with R[BigDecimal]

def boolean(name: String, description: String = null): P[Boolean] with R[Boolean]

def clone(): AnyRef

def dateTime(name: String, description: String = null): P[LocalDateTime] with R[LocalDateTime]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

def int(name: String, description: String = null): P[Int] with R[Int]

def integer(name: String, description: String = null): P[Integer] with R[Integer]

final def isInstanceOf[T0]: Boolean

def json[T](name: String, description: String = null, jsonLib: JsonLibrary[T, _] = Argo): P[T] with R[T]

def localDate(name: String, description: String = null): P[LocalDate] with R[LocalDate]

def long(name: String, description: String = null): P[Long] with R[Long]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def string(name: String, description: String = null, validation: StringValidations.Rule = StringValidations.EmptyIsInvalid): P[String] with R[String]

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

def uuid(name: String, description: String = null): P[UUID] with R[UUID]

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

def xml(name: String, description: String = null): P[Elem] with R[Elem]

def zonedDateTime(name: String, description: String = null): P[ZonedDateTime] with R[ZonedDateTime]

Inherited from AnyRef

Inherited from Any

Ungrouped