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
- Alphabetic
- By Inheritance
- MediaType
- WithQValue
- LazyValueBytesRenderable
- Renderable
- MediaType
- AnyRef
- Any
- by apply
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
- 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
- abstract def comp: Compressibility
- abstract def fileExtensions: List[String]
- abstract def params: Map[String, String]
- abstract def value: String
- Definition Classes
- LazyValueBytesRenderable
- abstract def withComp(comp: Compressibility): MediaType
- abstract def withParams(params: Map[String, String]): MediaType
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- def ->[B](y: B): (MediaType, B)
- 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: (MediaType) => Boolean, msg: => Any): MediaType
- def ensuring(cond: (MediaType) => Boolean): MediaType
- def ensuring(cond: Boolean, msg: => Any): MediaType
- def ensuring(cond: Boolean): MediaType
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(that: Any): Boolean
- Definition Classes
- MediaType → 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 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
- MediaRange → MediaRange
- def hashCode(): Int
- Definition Classes
- MediaType → AnyRef → Any
- def isApplication: Boolean
- def isAudio: Boolean
- def isCompressible: Boolean
True when this media-type is generally compressible.
- def isImage: Boolean
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def isMessage: Boolean
- def isMultipart: Boolean
- def isText: Boolean
- def isVideo: Boolean
- 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
- val mainType: String
The main-type of this media-type.
- 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
- MediaRange → MediaRange
- 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
- 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()
- 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
- MediaRange → MediaRange
- def render[R <: Rendering](r: R): r.type
- Definition Classes
- LazyValueBytesRenderable → Renderable
- val subType: String
The sub-type of this media-type.
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toRange(qValue: Float): javadsl.model.MediaRange
Creates a media-range from this media-type with a given qValue.
- def toRange: javadsl.model.MediaRange
JAVA API
- def toString(): String
- Definition Classes
- LazyValueBytesRenderable → AnyRef → Any
- 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()
- 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
- def withQValue(qValue: Float): MediaRange
- Definition Classes
- MediaType → WithQValue
- 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
- 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
- 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
- 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
- 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
- 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
- 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
- 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
- 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
- MediaRange → MediaRange
- 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
- 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
- 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
- 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
- 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
- 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 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): (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.