sealed abstract class MediaType extends javadsl.model.MediaType with LazyValueBytesRenderable with WithQValue[MediaRange]

A MediaType describes the type of the content of an HTTP message entity.

While knowledge of the MediaType alone suffices for being able to properly interpret binary content this is not generally the case for non-binary (i.e. character-based) content, which also requires the definition of a specific character encoding (HttpCharset). Therefore MediaType instances are frequently encountered as a member of a ContentType, which groups a MediaType with a potentially required HttpCharset to hold everything required for being able to interpret an HttpEntity.

MediaTypes come in three basic forms:

1. Binary: These do not need an additional HttpCharset to be able to form a ContentType. Therefore they can be implicitly converted to the latter.

2. WithOpenCharset: Most character-based MediaTypes are of this form, which can be combined with all HttpCharset instances to form a ContentType.

3. WithFixedCharset: Some character-based MediaTypes prescribe a single, clearly defined charset and as such, similarly to binary MediaTypes, do not require the addition of an HttpCharset instances to form a ContentType. The most prominent example is probably application/json which must always be UTF-8 encoded. Like binary MediaTypes WithFixedCharset types can be implicitly converted to a ContentType.

Not for user extension.

Annotations
@DoNotInherit()
Source
MediaType.scala
Linear Supertypes
WithQValue[MediaRange], LazyValueBytesRenderable, Renderable, javadsl.model.MediaType, AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. MediaType
  2. WithQValue
  3. LazyValueBytesRenderable
  4. Renderable
  5. MediaType
  6. AnyRef
  7. Any
Implicitly
  1. by apply
  2. by any2stringadd
  3. by StringFormat
  4. by Ensuring
  5. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def binary: Boolean

    True when this media-type is not character-based.

    True when this media-type is not character-based.

    Definition Classes
    MediaType
  2. abstract def comp: Compressibility
  3. abstract def fileExtensions: List[String]
  4. abstract def params: Map[String, String]
  5. abstract def value: String
    Definition Classes
    LazyValueBytesRenderable
  6. abstract def withComp(comp: Compressibility): MediaType
  7. abstract def withParams(params: Map[String, String]): MediaType

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 MediaType toany2stringadd[MediaType] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (MediaType, B)
    Implicit
    This member is added by an implicit conversion from MediaType toArrowAssoc[MediaType] 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: (MediaType) => Boolean, msg: => Any): MediaType
    Implicit
    This member is added by an implicit conversion from MediaType toEnsuring[MediaType] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (MediaType) => Boolean): MediaType
    Implicit
    This member is added by an implicit conversion from MediaType toEnsuring[MediaType] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: => Any): MediaType
    Implicit
    This member is added by an implicit conversion from MediaType toEnsuring[MediaType] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): MediaType
    Implicit
    This member is added by an implicit conversion from MediaType toEnsuring[MediaType] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(that: Any): Boolean
    Definition Classes
    MediaType → 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 getParams(): Map[String, String]

    Java API

    Java API

    Implicit
    This member is added by an implicit conversion from MediaType toMediaRange performed by method apply in org.apache.pekko.http.scaladsl.model.MediaRange.
    Definition Classes
    MediaRangeMediaRange
  17. def hashCode(): Int
    Definition Classes
    MediaType → AnyRef → Any
  18. def isApplication: Boolean
    Definition Classes
    MediaTypeMediaType
  19. def isAudio: Boolean
    Definition Classes
    MediaTypeMediaType
  20. def isCompressible: Boolean

    True when this media-type is generally compressible.

    True when this media-type is generally compressible.

    Definition Classes
    MediaTypeMediaType
  21. def isImage: Boolean
    Definition Classes
    MediaTypeMediaType
  22. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  23. def isMessage: Boolean
    Definition Classes
    MediaTypeMediaType
  24. def isMultipart: Boolean
    Definition Classes
    MediaTypeMediaType
  25. def isText: Boolean
    Definition Classes
    MediaTypeMediaType
  26. def isVideo: Boolean
    Definition Classes
    MediaTypeMediaType
  27. def isWildcard: Boolean
    Implicit
    This member is added by an implicit conversion from MediaType toMediaRange performed by method apply in org.apache.pekko.http.scaladsl.model.MediaRange.
    Definition Classes
    MediaRange
  28. val mainType: String

    The main-type of this media-type.

    The main-type of this media-type.

    Definition Classes
    MediaTypeMediaType
  29. def matches(mediaType: javadsl.model.MediaType): Boolean

    Java API

    Java API

    Implicit
    This member is added by an implicit conversion from MediaType toMediaRange performed by method apply in org.apache.pekko.http.scaladsl.model.MediaRange.
    Definition Classes
    MediaRangeMediaRange
  30. def matches(mediaType: MediaType): Boolean
    Implicit
    This member is added by an implicit conversion from MediaType toMediaRange performed by method apply in org.apache.pekko.http.scaladsl.model.MediaRange.
    Definition Classes
    MediaRange
  31. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  32. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  33. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  34. def qValue(): Float

    Returns the qValue of this media-range.

    Returns the qValue of this media-range.

    Implicit
    This member is added by an implicit conversion from MediaType toMediaRange performed by method apply in org.apache.pekko.http.scaladsl.model.MediaRange.
    Definition Classes
    MediaRangeMediaRange
  35. def render[R <: Rendering](r: R): r.type
    Definition Classes
    LazyValueBytesRenderable → Renderable
  36. val subType: String

    The sub-type of this media-type.

    The sub-type of this media-type.

    Definition Classes
    MediaTypeMediaType
  37. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  38. def toRange(qValue: Float): javadsl.model.MediaRange

    Creates a media-range from this media-type with a given qValue.

    Creates a media-range from this media-type with a given qValue.

    Definition Classes
    MediaTypeMediaType
  39. def toRange: javadsl.model.MediaRange

    JAVA API

    JAVA API

    Definition Classes
    MediaTypeMediaType
  40. def toString(): String
    Definition Classes
    LazyValueBytesRenderable → AnyRef → Any
  41. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  42. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  43. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  44. def withCharsetRange(charsetRange: HttpCharsetRange): ContentTypeRange

    Constructs a ContentTypeRange from this instance and the given charset.

    Constructs a ContentTypeRange from this instance and the given charset.

    Implicit
    This member is added by an implicit conversion from MediaType toMediaRange performed by method apply in org.apache.pekko.http.scaladsl.model.MediaRange.
    Definition Classes
    MediaRange
  45. def withQValue(qValue: Float): MediaRange
    Definition Classes
    MediaTypeWithQValue
  46. def withQValue(qValue: Double): MediaRange

    truncates Double qValue to float and returns a new instance with this qValue set

    truncates Double qValue to float and returns a new instance with this qValue set

    Definition Classes
    WithQValue

Shadowed Implicit Value Members

  1. def isApplication: Boolean
    Implicit
    This member is added by an implicit conversion from MediaType toMediaRange performed by method apply in org.apache.pekko.http.scaladsl.model.MediaRange.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (mediaType: MediaRange).isApplication
    Definition Classes
    MediaRange
  2. def isAudio: Boolean
    Implicit
    This member is added by an implicit conversion from MediaType toMediaRange performed by method apply in org.apache.pekko.http.scaladsl.model.MediaRange.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (mediaType: MediaRange).isAudio
    Definition Classes
    MediaRange
  3. def isImage: Boolean
    Implicit
    This member is added by an implicit conversion from MediaType toMediaRange performed by method apply in org.apache.pekko.http.scaladsl.model.MediaRange.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (mediaType: MediaRange).isImage
    Definition Classes
    MediaRange
  4. def isMessage: Boolean
    Implicit
    This member is added by an implicit conversion from MediaType toMediaRange performed by method apply in org.apache.pekko.http.scaladsl.model.MediaRange.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (mediaType: MediaRange).isMessage
    Definition Classes
    MediaRange
  5. def isMultipart: Boolean
    Implicit
    This member is added by an implicit conversion from MediaType toMediaRange performed by method apply in org.apache.pekko.http.scaladsl.model.MediaRange.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (mediaType: MediaRange).isMultipart
    Definition Classes
    MediaRange
  6. def isText: Boolean
    Implicit
    This member is added by an implicit conversion from MediaType toMediaRange performed by method apply in org.apache.pekko.http.scaladsl.model.MediaRange.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (mediaType: MediaRange).isText
    Definition Classes
    MediaRange
  7. def isVideo: Boolean
    Implicit
    This member is added by an implicit conversion from MediaType toMediaRange performed by method apply in org.apache.pekko.http.scaladsl.model.MediaRange.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (mediaType: MediaRange).isVideo
    Definition Classes
    MediaRange
  8. def mainType(): String

    Returns the main-type this media-range matches.

    Returns the main-type this media-range matches.

    Implicit
    This member is added by an implicit conversion from MediaType toMediaRange performed by method apply in org.apache.pekko.http.scaladsl.model.MediaRange.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (mediaType: MediaRange).mainType()
    Definition Classes
    MediaRangeMediaRange
  9. def params: Map[String, String]
    Implicit
    This member is added by an implicit conversion from MediaType toMediaRange performed by method apply in org.apache.pekko.http.scaladsl.model.MediaRange.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (mediaType: MediaRange).params
    Definition Classes
    MediaRange
  10. def value: String
    Implicit
    This member is added by an implicit conversion from MediaType toMediaRange performed by method apply in org.apache.pekko.http.scaladsl.model.MediaRange.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (mediaType: MediaRange).value
    Definition Classes
    MediaRange
  11. def withParams(params: Map[String, String]): MediaRange

    Returns a copy of this instance with the params replaced by the given ones.

    Returns a copy of this instance with the params replaced by the given ones. If the given map contains a "q" value the qValue member is (also) updated.

    Implicit
    This member is added by an implicit conversion from MediaType toMediaRange performed by method apply in org.apache.pekko.http.scaladsl.model.MediaRange.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (mediaType: MediaRange).withParams(params)
    Definition Classes
    MediaRange
  12. def withQValue(qValue: Double): MediaRange

    truncates Double qValue to float and returns a new instance with this qValue set

    truncates Double qValue to float and returns a new instance with this qValue set

    Implicit
    This member is added by an implicit conversion from MediaType toMediaRange performed by method apply in org.apache.pekko.http.scaladsl.model.MediaRange.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (mediaType: MediaRange).withQValue(qValue)
    Definition Classes
    WithQValue
  13. def withQValue(qValue: Float): MediaRange
    Implicit
    This member is added by an implicit conversion from MediaType toMediaRange performed by method apply in org.apache.pekko.http.scaladsl.model.MediaRange.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (mediaType: MediaRange).withQValue(qValue)
    Definition Classes
    WithQValue

Deprecated Value Members

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

Inherited from LazyValueBytesRenderable

Inherited from Renderable

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion apply fromMediaType to MediaRange

Inherited by implicit conversion any2stringadd fromMediaType to any2stringadd[MediaType]

Inherited by implicit conversion StringFormat fromMediaType to StringFormat[MediaType]

Inherited by implicit conversion Ensuring fromMediaType to Ensuring[MediaType]

Inherited by implicit conversion ArrowAssoc fromMediaType to ArrowAssoc[MediaType]

Ungrouped