abstract class CustomHeader extends javadsl.model.headers.CustomHeader
Superclass for user-defined custom headers defined by implementing name
and value
.
Prefer to extend ModeledCustomHeader and ModeledCustomHeaderCompanion instead if planning to use the defined header in match clauses (e.g. in the routing layer of Pekko HTTP), as they allow the custom header to be matched from RawHeader and vice-versa.
- Source
- headers.scala
- Alphabetic
- By Inheritance
- CustomHeader
- CustomHeader
- HttpHeader
- ToStringRenderable
- Renderable
- HttpHeader
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new CustomHeader()
Abstract Value Members
- abstract def name(): String
Returns the name of the header.
Returns the name of the header.
- Definition Classes
- CustomHeader → HttpHeader → HttpHeader
- 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
- 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
- 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
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- Implicit
- This member is added by an implicit conversion from CustomHeader toany2stringadd[CustomHeader] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- def ->[B](y: B): (CustomHeader, B)
- Implicit
- This member is added by an implicit conversion from CustomHeader toArrowAssoc[CustomHeader] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def ensuring(cond: (CustomHeader) => Boolean, msg: => Any): CustomHeader
- Implicit
- This member is added by an implicit conversion from CustomHeader toEnsuring[CustomHeader] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (CustomHeader) => Boolean): CustomHeader
- Implicit
- This member is added by an implicit conversion from CustomHeader toEnsuring[CustomHeader] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): CustomHeader
- Implicit
- This member is added by an implicit conversion from CustomHeader toEnsuring[CustomHeader] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): CustomHeader
- Implicit
- This member is added by an implicit conversion from CustomHeader toEnsuring[CustomHeader] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- 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
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def isNot(nameInLowerCase: String): Boolean
Returns !is(nameInLowerCase).
Returns !is(nameInLowerCase).
- Definition Classes
- HttpHeader → HttpHeader
- def lowercaseName(): String
Returns the lower-cased name of the header.
Returns the lower-cased name of the header.
- Definition Classes
- CustomHeader → HttpHeader → HttpHeader
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def render[R <: Rendering](r: R): r.type
- Definition Classes
- CustomHeader → Renderable
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- ToStringRenderable → AnyRef → Any
- def unsafeToString: String
- Definition Classes
- HttpHeader
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
Deprecated Value Members
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from CustomHeader toStringFormat[CustomHeader] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.12.16) Use
formatString.format(value)
instead ofvalue.formatted(formatString)
, or use thef""
string interpolator. In Java 15 and later,formatted
resolves to the new method in String which has reversed parameters.
- def →[B](y: B): (CustomHeader, B)
- Implicit
- This member is added by an implicit conversion from CustomHeader toArrowAssoc[CustomHeader] 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.