HeaderParam

Parameter that binds to a value in the header

name: Name of the request parameter
description: Short description of the parameter
headerName: Name of the header field. If empty (default), then the header field name is assumed to be the same as name.
allowMultiple: Specifies that a comma-separated list of values can be passed. Defaults to false.
allowableValues: Input validation

Linear Supertypes

Serializable, Serializable, Product, Equals, RequestParam, AnyRef, Any

Instance Constructors

new HeaderParam(name: String, description: String = "", headerName: String = "", allowMultiple: Boolean = false, allowableValues: Option[AllowableValues] = None)

name
Name of the request parameter
description
Short description of the parameter
headerName
Name of the header field. If empty (default), then the header field name is assumed to be the same as name.
allowMultiple
Specifies that a comma-separated list of values can be passed. Defaults to false.
allowableValues
Input validation

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
val allowMultiple: Boolean

Specifies that a comma-separated list of values can be passed.
Specifies that a comma-separated list of values can be passed. Defaults to false.

Definition Classes
HeaderParam → RequestParam
val allowableValues: Option[AllowableValues]

Input validation
Input validation

Definition Classes
HeaderParam → RequestParam
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val description: String

Short description of the parameter
Short description of the parameter

Definition Classes
HeaderParam → RequestParam
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def finalize(): Unit

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

Definition Classes
AnyRef → Any
val headerName: String

Name of the header field.
Name of the header field. If empty (default), then the header field name is assumed to be the same as name.
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
val name: String

Name of the request parameter
Name of the request parameter

Definition Classes
HeaderParam → RequestParam
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val paramType: String

Definition Classes
HeaderParam → RequestParam
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
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( ... )

case class HeaderParam(name: String, description: String = "", headerName: String = "", allowMultiple: Boolean = false, allowableValues: Option[AllowableValues] = None) extends RequestParam with Product with Serializable

Instance Constructors

new HeaderParam(name: String, description: String = "", headerName: String = "", allowMultiple: Boolean = false, allowableValues: Option[AllowableValues] = None)

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

val allowMultiple: Boolean

val allowableValues: Option[AllowableValues]

final def asInstanceOf[T0]: T0

def clone(): AnyRef

val description: String

final def eq(arg0: AnyRef): Boolean

def finalize(): Unit

final def getClass(): Class[_]

val headerName: String

final def isInstanceOf[T0]: Boolean

val name: String

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val paramType: String

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

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from RequestParam

Inherited from AnyRef

Inherited from Any

Ungrouped