Packages

abstract class ModeledCustomHeader extends CustomHeader

Support class for building user-defined custom headers defined by implementing name and value. Implement ModeledCustomHeader and ModeledCustomHeaderFactory instead of CustomHeader to be able to use the convenience methods that allow parsing the custom user-defined header from org.apache.pekko.http.javadsl.model.HttpHeader.

Source
ModeledCustomHeader.java
Linear Supertypes
CustomHeader, scaladsl.model.HttpHeader, ToStringRenderable, Renderable, HttpHeader, AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ModeledCustomHeader
  2. CustomHeader
  3. HttpHeader
  4. ToStringRenderable
  5. Renderable
  6. HttpHeader
  7. AnyRef
  8. 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(name: String, value: String)
    Attributes
    protected[headers]

Abstract Value Members

  1. 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
  2. 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

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 toany2stringadd[ModeledCustomHeader] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (ModeledCustomHeader, B)
    Implicit
    This member is added by an implicit conversion from ModeledCustomHeader toArrowAssoc[ModeledCustomHeader] 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]) @native()
  8. def ensuring(cond: (ModeledCustomHeader) => Boolean, msg: => Any): ModeledCustomHeader
    Implicit
    This member is added by an implicit conversion from ModeledCustomHeader toEnsuring[ModeledCustomHeader] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (ModeledCustomHeader) => Boolean): ModeledCustomHeader
    Implicit
    This member is added by an implicit conversion from ModeledCustomHeader toEnsuring[ModeledCustomHeader] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: => Any): ModeledCustomHeader
    Implicit
    This member is added by an implicit conversion from ModeledCustomHeader toEnsuring[ModeledCustomHeader] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): ModeledCustomHeader
    Implicit
    This member is added by an implicit conversion from ModeledCustomHeader toEnsuring[ModeledCustomHeader] 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. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  15. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  16. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. 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
  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. def isNot(nameInLowerCase: String): Boolean

    Returns !is(nameInLowerCase).

    Returns !is(nameInLowerCase).

    Definition Classes
    HttpHeader → HttpHeader
  20. def lowercaseName(): String

    Returns the lower-cased name of the header.

    Returns the lower-cased name of the header.

    Definition Classes
    ModeledCustomHeader → HttpHeader → HttpHeader
    Annotations
    @Override()
  21. def name(): String

    Returns the name of the header.

    Returns the name of the header.

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

Deprecated Value Members

  1. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from ModeledCustomHeader toStringFormat[ModeledCustomHeader] 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.

  2. def →[B](y: B): (ModeledCustomHeader, B)
    Implicit
    This member is added by an implicit conversion from ModeledCustomHeader toArrowAssoc[ModeledCustomHeader] 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 scaladsl.model.HttpHeader

Inherited from ToStringRenderable

Inherited from Renderable

Inherited from HttpHeader

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromModeledCustomHeader to any2stringadd[ModeledCustomHeader]

Inherited by implicit conversion StringFormat fromModeledCustomHeader to StringFormat[ModeledCustomHeader]

Inherited by implicit conversion Ensuring fromModeledCustomHeader to Ensuring[ModeledCustomHeader]

Inherited by implicit conversion ArrowAssoc fromModeledCustomHeader to ArrowAssoc[ModeledCustomHeader]

Ungrouped