org.mashupbots.socko.rest

HeaderBinding

case class HeaderBinding(config: RestConfig, registration: HeaderParam, tpe: scala.reflect.api.JavaUniverse.Type, required: Boolean) extends PrimitiveParamBinding with Product with Serializable

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

Example

case class(context: RestRequestContext, @RestHeader() rows: Int) extends RestRequest
config

REST config

registration

Parameter meta data

tpe

Type of the field

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, PrimitiveParamBinding, RequestParamBinding, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. HeaderBinding
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. PrimitiveParamBinding
  7. RequestParamBinding
  8. AnyRef
  9. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new HeaderBinding(config: RestConfig, registration: HeaderParam, tpe: scala.reflect.api.JavaUniverse.Type, required: Boolean)

    config

    REST config

    registration

    Parameter meta data

    tpe

    Type of the field

    required

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

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any

  3. final def ##(): Int

    Definition Classes
    AnyRef → Any

  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any

  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  7. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  8. val config: RestConfig

    REST config

    REST config

    Definition Classes
    HeaderBinding → RequestParamBinding

  9. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  10. 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

    httpRequestEvent

    HTTP request event

    returns

    a value for passing to the constructor

    Definition Classes
    HeaderBinding → RequestParamBinding

  11. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  12. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  13. val headerFieldName: String

  14. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  15. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  16. final def notify(): Unit

    Definition Classes
    AnyRef

  17. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  18. val primitiveParser: (String) ⇒ Any

    Parse a string into the specified

    Parse a string into the specified

    We load this at initialization so it is done once.

    Definition Classes
    PrimitiveParamBinding

  19. val registration: HeaderParam

    Parameter meta data

    Parameter meta data

    Definition Classes
    HeaderBinding → RequestParamBinding

  20. 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
    HeaderBinding → RequestParamBinding

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

    Definition Classes
    AnyRef

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

    Type of the field

    Type of the field

    Definition Classes
    HeaderBinding → RequestParamBinding

  23. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  25. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from PrimitiveParamBinding

Inherited from RequestParamBinding

Inherited from AnyRef

Inherited from Any

Ungrouped