BodyBinding

Binds a value in the request class to a value in the request body

Example

case class(context: RestRequestContext, @RestBody() pet: Pet) extends RestRequest

name = pet
tpe = Pet
clz = Class.forName("my.package.Pet")
description = ""
required = true

config: REST config
registration: Parameter meta data
tpeCategory: Our categorization of the type of the field
tpe: Type of the field
objectClass: For object fields that needs to be deserialized, this is the Java class of the field. For other categories of deserialization (primitive, bytes, etc) this is set to None and not used.
required: Flag to indicate if this field is required or not. If not, it must be of type Option[_]

Linear Supertypes

Serializable, Serializable, Product, Equals, RequestParamBinding, AnyRef, Any

Instance Constructors

new BodyBinding(config: RestConfig, registration: BodyParam, tpeCategory: RequestBodyDataType.Value, tpe: scala.reflect.api.JavaUniverse.Type, objectClass: Option[Class[_]], required: Boolean)

config
REST config
registration
Parameter meta data
tpeCategory
Our categorization of the type of the field
tpe
Type of the field
objectClass
For object fields that needs to be deserialized, this is the Java class of the field. For other categories of deserialization (primitive, bytes, etc) this is set to None and not used.
required
Flag to indicate if this field is required or not. If not, it must be of type Option[_]

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 clone(): AnyRef

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

REST config
REST config

Definition Classes
BodyBinding → RequestParamBinding
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def extract(context: RestRequestContext, requestClassName: String, httpRequestEvent: HttpRequestEvent): Any

Parse incoming request data into a value for binding to a org.mashupbots.socko.rest.RestRequest
Parse incoming request data into a value for binding to a org.mashupbots.socko.rest.RestRequest
context
Request context
requestClassName
Request class name
httpRequestEvent
HTTP request event
returns
a value for passing to the constructor

Definition Classes
BodyBinding → RequestParamBinding
def finalize(): Unit

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

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

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

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val objectClass: Option[Class[_]]

For object fields that needs to be deserialized, this is the Java class of the field.
For object fields that needs to be deserialized, this is the Java class of the field. For other categories of deserialization (primitive, bytes, etc) this is set to None and not used.
val primitiveParser: Option[(String) ⇒ Any]

Parse a string into the specified
Parse a string into the specified
We load this at initialization so it is done once.
val registration: BodyParam

Parameter meta data
Parameter meta data

Definition Classes
BodyBinding → RequestParamBinding
val required: Boolean

Flag to indicate if this field is required or not.
Flag to indicate if this field is required or not. If not, it must be of type Option[_]

Definition Classes
BodyBinding → RequestParamBinding
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
val tpe: scala.reflect.api.JavaUniverse.Type

Type of the field
Type of the field

Definition Classes
BodyBinding → RequestParamBinding
val tpeCategory: RequestBodyDataType.Value

Our categorization of the type of the field
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 BodyBinding(config: RestConfig, registration: BodyParam, tpeCategory: RequestBodyDataType.Value, tpe: scala.reflect.api.JavaUniverse.Type, objectClass: Option[Class[_]], required: Boolean) extends RequestParamBinding with Product with Serializable

Example

Instance Constructors

new BodyBinding(config: RestConfig, registration: BodyParam, tpeCategory: RequestBodyDataType.Value, tpe: scala.reflect.api.JavaUniverse.Type, objectClass: Option[Class[_]], required: Boolean)

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

val config: RestConfig

final def eq(arg0: AnyRef): Boolean

def extract(context: RestRequestContext, requestClassName: String, httpRequestEvent: HttpRequestEvent): Any

def finalize(): Unit

final def getClass(): Class[_]

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val objectClass: Option[Class[_]]

val primitiveParser: Option[(String) ⇒ Any]

val registration: BodyParam

val required: Boolean

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

val tpe: scala.reflect.api.JavaUniverse.Type

val tpeCategory: RequestBodyDataType.Value

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 RequestParamBinding

Inherited from AnyRef

Inherited from Any

Ungrouped