Parameters

Instance Constructors

new Parameters(builder: ParameterBuilder[P])

Attributes
protected[io.fintrospect.parameters]

Value Members

final def !=(arg0: AnyRef): Boolean

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

Definition Classes
Any
final def ##(): Int

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

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

Definition Classes
Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def bigDecimal(name: String, description: String = null): P[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]

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 custom[T](name: String, attemptToParse: (String) ⇒ Try[T], description: String = null): P[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
name
the name of the parameter (for use in description endpoints)
attemptToParse
function to take the input string from the request and attempt to construct a deserialized instance
description
optional description of the parameter (for use in description endpoints)
returns
a parameter for retrieving a value of type [T] from the request
def dateTime(name: String, description: String = null): P[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]

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]

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(name: String, description: String = null): P[JsonNode]

Create a Argo-format JsonNode parameter which is constrained to values which parse to valid JSON objects
Create a Argo-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]

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]

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): P[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)
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
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 zonedDateTime(name: String, description: String = null): P[ZonedDateTime]

Create a ZonedDateTime parameter which is constrained by the format YYYY-MM-DDTHH:mm:SSZ (See DateTimeFormatter.
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

class Parameters[P[_]] extends AnyRef

Instance Constructors

new Parameters(builder: ParameterBuilder[P])

Value Members

final def !=(arg0: AnyRef): Boolean

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: AnyRef): Boolean

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

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

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

def clone(): AnyRef

def custom[T](name: String, attemptToParse: (String) ⇒ Try[T], description: String = null): P[T]

def dateTime(name: String, description: String = null): P[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]

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

final def isInstanceOf[T0]: Boolean

def json(name: String, description: String = null): P[JsonNode]

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

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

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def string(name: String, description: String = null): P[String]

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

def toString(): String

final def wait(): Unit

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

final def wait(arg0: Long): Unit

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

Inherited from AnyRef

Inherited from Any

Ungrouped