abstract class HttpHeader extends javadsl.model.HttpHeader with ToStringRenderable

The model of an HTTP header. In its most basic form headers are simple name-value pairs. Header names are compared in a case-insensitive way.

Source
HttpHeader.scala
Linear Supertypes
ToStringRenderable, Renderable, javadsl.model.HttpHeader, AnyRef, Any
Known Subclasses
Accept, AcceptCharset, AcceptEncoding, AcceptLanguage, AcceptRanges, AccessControlAllowCredentials, AccessControlAllowHeaders, AccessControlAllowMethods, AccessControlAllowOrigin, AccessControlExposeHeaders, AccessControlMaxAge, AccessControlRequestHeaders, AccessControlRequestMethod, Age, Allow, Authorization, CacheControl, Connection, ContentDisposition, ContentEncoding, ContentLength, ContentLocation, ContentRange, ContentType, Cookie, CustomHeader, Date, ETag, Expires, Host, IfMatch, IfModifiedSince, IfNoneMatch, IfUnmodifiedSince, LastEventId, LastModified, Link, Location, ModeledCustomHeader, Origin, ProxyAuthenticate, ProxyAuthorization, Range, RawHeader, RawRequestURI, Referer, RetryAfter, SecWebSocketProtocol, Server, SetCookie, StrictTransportSecurity, TE, TimeoutAccess, TlsSessionInfo, TransferEncoding, UserAgent, WWWAuthenticate, XForwardedFor, XForwardedHost, XForwardedProto, XRealIp, Accept, Accept-Charset, Accept-Encoding, Accept-Language, Accept-Ranges, Access-Control-Allow-Credentials, Access-Control-Allow-Headers, Access-Control-Allow-Methods, Access-Control-Allow-Origin, Access-Control-Expose-Headers, Access-Control-Max-Age, Access-Control-Request-Headers, Access-Control-Request-Method, Age, Allow, Authorization, Cache-Control, Connection, Content-Disposition, Content-Encoding, Content-Length, Content-Location, Content-Range, Content-Type, Cookie, CustomHeader, Date, ETag, Expect, Expires, Host, If-Match, If-Modified-Since, If-None-Match, If-Range, If-Unmodified-Since, Last-Event-ID, Last-Modified, Link, Location, ModeledCustomHeader, ModeledHeader, Origin, Proxy-Authenticate, Proxy-Authorization, Range, Raw-Request-URI, RawHeader, Referer, Retry-After, Server, Set-Cookie, Strict-Transport-Security, TE, Timeout-Access, Tls-Session-Info, Transfer-Encoding, Upgrade, User-Agent, WWW-Authenticate, X-Forwarded-For, X-Forwarded-Host, X-Forwarded-Proto, X-Real-Ip, RemoteAddress, UpgradeToWebSocket, Remote-Address, UpgradeToWebSocket
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. HttpHeader
  2. ToStringRenderable
  3. Renderable
  4. HttpHeader
  5. AnyRef
  6. 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 HttpHeader()

Abstract Value Members

  1. abstract def lowercaseName(): String

    Returns the lower-cased name of the header.

    Returns the lower-cased name of the header.

    Definition Classes
    HttpHeaderHttpHeader
  2. abstract def name(): String

    Returns the name of the header.

    Returns the name of the header.

    Definition Classes
    HttpHeaderHttpHeader
  3. 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
  4. 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
  5. 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
    HttpHeaderHttpHeader

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 HttpHeader toany2stringadd[HttpHeader] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (HttpHeader, B)
    Implicit
    This member is added by an implicit conversion from HttpHeader toArrowAssoc[HttpHeader] 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: (HttpHeader) => Boolean, msg: => Any): HttpHeader
    Implicit
    This member is added by an implicit conversion from HttpHeader toEnsuring[HttpHeader] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (HttpHeader) => Boolean): HttpHeader
    Implicit
    This member is added by an implicit conversion from HttpHeader toEnsuring[HttpHeader] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: => Any): HttpHeader
    Implicit
    This member is added by an implicit conversion from HttpHeader toEnsuring[HttpHeader] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): HttpHeader
    Implicit
    This member is added by an implicit conversion from HttpHeader toEnsuring[HttpHeader] 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
    HttpHeaderHttpHeader
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. def isNot(nameInLowerCase: String): Boolean

    Returns !is(nameInLowerCase).

    Returns !is(nameInLowerCase).

    Definition Classes
    HttpHeaderHttpHeader
  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  22. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  23. def toString(): String
    Definition Classes
    ToStringRenderable → AnyRef → Any
  24. def unsafeToString: String
  25. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  26. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  27. 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 HttpHeader toStringFormat[HttpHeader] 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): (HttpHeader, B)
    Implicit
    This member is added by an implicit conversion from HttpHeader toArrowAssoc[HttpHeader] 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 ToStringRenderable

Inherited from Renderable

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromHttpHeader to any2stringadd[HttpHeader]

Inherited by implicit conversion StringFormat fromHttpHeader to StringFormat[HttpHeader]

Inherited by implicit conversion Ensuring fromHttpHeader to Ensuring[HttpHeader]

Inherited by implicit conversion ArrowAssoc fromHttpHeader to ArrowAssoc[HttpHeader]

Ungrouped