Path

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
def apply[T](spec: ParameterSpec[T]): PathParameter[T] with PathBindable[T] { ... /* 2 definitions in type refinement */ }

Create a path parameter using the passed specification
Create a path parameter using the passed specification
T
the type of the parameter
spec
the parameter spec
returns
a parameter for retrieving a value of type [T] from the request

Definition Classes
Path → Parameters
def apply[T](parameterSpecSupplier: ParameterSpecSupplier[T]): PathParameter[T] with PathBindable[T]

Create a parameter of a custom type using the spec supplied by the Supplier
Create a parameter of a custom type using the spec supplied by the Supplier
T
the type of the parameter
parameterSpecSupplier
provides a parameter spec
returns
a parameter for retrieving a value of type [T] from the request

Definition Classes
Parameters
final def asInstanceOf[T0]: T0

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

Definition Classes
Parameters
def boolean(name: String, description: String = null): PathParameter[Boolean] with PathBindable[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

Definition Classes
Parameters
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def dateTime(name: String, description: String = null): PathParameter[LocalDateTime] with PathBindable[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

Definition Classes
Parameters
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] )
def fixed(name: String): PathParameter[String]

A special path segment that is defined, but has no intrinsic value other than for route matching.
A special path segment that is defined, but has no intrinsic value other than for route matching. Useful when embedded between 2 other path parameters. eg. /myRoute/{id}/aFixedPart/{subId}
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
def int(name: String, description: String = null): PathParameter[Int] with PathBindable[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

Definition Classes
Parameters
def integer(name: String, description: String = null): PathParameter[Integer] with PathBindable[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

Definition Classes
Parameters
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def json[T](name: String, description: String = null, jsonLib: JsonLibrary[T, _] = Argo): PathParameter[T] with PathBindable[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

Definition Classes
Parameters
def localDate(name: String, description: String = null): PathParameter[LocalDate] with PathBindable[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

Definition Classes
Parameters
def long(name: String, description: String = null): PathParameter[Long] with PathBindable[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

Definition Classes
Parameters
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.EmptyIsValid): PathParameter[String] with PathBindable[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

Definition Classes
Parameters
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
def uuid(name: String, description: String = null): PathParameter[UUID] with PathBindable[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

Definition Classes
Parameters
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): PathParameter[Elem] with PathBindable[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

Definition Classes
Parameters
def zonedDateTime(name: String, description: String = null): PathParameter[ZonedDateTime] with PathBindable[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

Definition Classes
Parameters

Related Doc: package parameters

object Path extends Parameters[PathParameter, PathBindable]

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

def apply[T](spec: ParameterSpec[T]): PathParameter[T] with PathBindable[T] { ... /* 2 definitions in type refinement */ }

def apply[T](parameterSpecSupplier: ParameterSpecSupplier[T]): PathParameter[T] with PathBindable[T]

final def asInstanceOf[T0]: T0

def bigDecimal(name: String, description: String = null): PathParameter[BigDecimal] with PathBindable[BigDecimal]

def boolean(name: String, description: String = null): PathParameter[Boolean] with PathBindable[Boolean]

def clone(): AnyRef

def dateTime(name: String, description: String = null): PathParameter[LocalDateTime] with PathBindable[LocalDateTime]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

def fixed(name: String): PathParameter[String]

final def getClass(): Class[_]

def hashCode(): Int

def int(name: String, description: String = null): PathParameter[Int] with PathBindable[Int]

def integer(name: String, description: String = null): PathParameter[Integer] with PathBindable[Integer]

final def isInstanceOf[T0]: Boolean

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

def localDate(name: String, description: String = null): PathParameter[LocalDate] with PathBindable[LocalDate]

def long(name: String, description: String = null): PathParameter[Long] with PathBindable[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.EmptyIsValid): PathParameter[String] with PathBindable[String]

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

def toString(): String

def uuid(name: String, description: String = null): PathParameter[UUID] with PathBindable[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): PathParameter[Elem] with PathBindable[Elem]

def zonedDateTime(name: String, description: String = null): PathParameter[ZonedDateTime] with PathBindable[ZonedDateTime]

Inherited from Parameters[PathParameter, PathBindable]

Inherited from AnyRef

Inherited from Any

Ungrouped