Packages

c

akka.http.scaladsl.model.headers

ModeledCustomHeader

abstract class ModeledCustomHeader[H <: ModeledCustomHeader[H]] extends CustomHeader

Support class for building user-defined custom headers defined by implementing name and value. By implementing a ModeledCustomHeader instead of CustomHeader directly, all needed unapply methods are provided for this class, such that it can be pattern matched on from RawHeader and the other way around as well.

Self Type
H
Source
headers.scala
Linear Supertypes
CustomHeader, javadsl.model.headers.CustomHeader, HttpHeader, ToStringRenderable, Renderable, javadsl.model.HttpHeader, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ModeledCustomHeader
  2. CustomHeader
  3. CustomHeader
  4. HttpHeader
  5. ToStringRenderable
  6. Renderable
  7. HttpHeader
  8. AnyRef
  9. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ModeledCustomHeader()

Abstract Value Members

  1. abstract def companion: ModeledCustomHeaderCompanion[H]
  2. abstract def renderInRequests(): Boolean

    Returns true if and only if the header is to be rendered in requests.

    Returns true if and only if the header is to be rendered in requests.

    Definition Classes
    HttpHeader
  3. abstract def renderInResponses(): Boolean

    Returns true if and only if the header is to be rendered in responses.

    Returns true if and only if the header is to be rendered in responses.

    Definition Classes
    HttpHeader
  4. abstract def value(): String

    Returns the String representation of the value of the header.

    Returns the String representation of the value of the header.

    Definition Classes
    CustomHeader → HttpHeader → HttpHeader

Concrete Value Members

  1. def is(nameInLowerCase: String): Boolean

    Returns true if and only if nameInLowerCase.equals(lowercaseName()).

    Returns true if and only if nameInLowerCase.equals(lowercaseName()).

    Definition Classes
    HttpHeader → HttpHeader
  2. def isNot(nameInLowerCase: String): Boolean

    Returns !is(nameInLowerCase).

    Returns !is(nameInLowerCase).

    Definition Classes
    HttpHeader → HttpHeader
  3. final def lowercaseName(): String

    Returns the lower-cased name of the header.

    Returns the lower-cased name of the header.

    Definition Classes
    ModeledCustomHeader → CustomHeader → HttpHeader → HttpHeader
  4. final def name(): String

    Returns the name of the header.

    Returns the name of the header.

    Definition Classes
    ModeledCustomHeader → CustomHeader → HttpHeader → HttpHeader
  5. final def render[R <: Rendering](r: R): r.type
    Definition Classes
    CustomHeader → Renderable
  6. def toString(): String
    Definition Classes
    ToStringRenderable → AnyRef → Any