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
Type Hierarchy
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. Protected

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. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from ModeledCustomHeader[H] toany2stringadd[ModeledCustomHeader[H]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (ModeledCustomHeader[H], B)
    Implicit
    This member is added by an implicit conversion from ModeledCustomHeader[H] toArrowAssoc[ModeledCustomHeader[H]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  8. def ensuring(cond: (ModeledCustomHeader[H]) => Boolean, msg: => Any): ModeledCustomHeader[H]
    Implicit
    This member is added by an implicit conversion from ModeledCustomHeader[H] toEnsuring[ModeledCustomHeader[H]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (ModeledCustomHeader[H]) => Boolean): ModeledCustomHeader[H]
    Implicit
    This member is added by an implicit conversion from ModeledCustomHeader[H] toEnsuring[ModeledCustomHeader[H]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: => Any): ModeledCustomHeader[H]
    Implicit
    This member is added by an implicit conversion from ModeledCustomHeader[H] toEnsuring[ModeledCustomHeader[H]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): ModeledCustomHeader[H]
    Implicit
    This member is added by an implicit conversion from ModeledCustomHeader[H] toEnsuring[ModeledCustomHeader[H]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  14. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  15. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  16. 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
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. def isNot(nameInLowerCase: String): Boolean

    Returns !is(nameInLowerCase).

    Returns !is(nameInLowerCase).

    Definition Classes
    HttpHeader → HttpHeader
  19. 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
  20. final def name(): String

    Returns the name of the header.

    Returns the name of the header.

    Definition Classes
    ModeledCustomHeader → CustomHeader → HttpHeader → HttpHeader
  21. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  23. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  24. final def render[R <: Rendering](r: R): r.type
    Definition Classes
    CustomHeader → Renderable
  25. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  26. def toString(): String
    Definition Classes
    ToStringRenderable → AnyRef → Any
  27. def unsafeToString: String
    Definition Classes
    HttpHeader
  28. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  29. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  30. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from ModeledCustomHeader[H] toStringFormat[ModeledCustomHeader[H]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  3. def →[B](y: B): (ModeledCustomHeader[H], B)
    Implicit
    This member is added by an implicit conversion from ModeledCustomHeader[H] toArrowAssoc[ModeledCustomHeader[H]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from CustomHeader

Inherited from javadsl.model.headers.CustomHeader

Inherited from HttpHeader

Inherited from ToStringRenderable

Inherited from Renderable

Inherited from javadsl.model.HttpHeader

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromModeledCustomHeader[H] to any2stringadd[ModeledCustomHeader[H]]

Inherited by implicit conversion StringFormat fromModeledCustomHeader[H] to StringFormat[ModeledCustomHeader[H]]

Inherited by implicit conversion Ensuring fromModeledCustomHeader[H] to Ensuring[ModeledCustomHeader[H]]

Inherited by implicit conversion ArrowAssoc fromModeledCustomHeader[H] to ArrowAssoc[ModeledCustomHeader[H]]

Ungrouped