Top Description Fields Constructors Methods
org.junit.jupiter.api

public sealed Class MediaType

extends Object
permits MediaType
Class Inheritance
Known Direct Subclasses
org.junit.jupiter.api.extension.MediaType
Annotations
@SuppressWarnings:removal
@API
status:MAINTAINED
since:5.14
Static Imports
java.nio.charset.StandardCharsets.UTF_8, org.apiguardian.api.API.Status.MAINTAINED

Represents a media type as defined by RFC 2045.

Warning

This type should not be extended by third parties.

Since
5.14
See Also
TestReporter#publishFile(Path, MediaType), TestReporter#publishFile(String, MediaType, org.junit.jupiter.api.function.ThrowingConsumer), org.junit.jupiter.api.extension.ExtensionContext#publishFile(String, MediaType, org.junit.jupiter.api.function.ThrowingConsumer)

Field Summary

Modifier and TypeField and Description
public static final MediaType
APPLICATION_JSON

The application/json media type.

public static final MediaType
APPLICATION_OCTET_STREAM

The application/octet-stream media type.

public static final MediaType
IMAGE_JPEG

The image/jpeg media type.

public static final MediaType
IMAGE_PNG

The image/png media type.

private static final Pattern
public static final MediaType
TEXT_PLAIN

The text/plain media type.

public static final MediaType
TEXT_PLAIN_UTF_8

The text/plain; charset=UTF-8 media type.

private final String

Constructor Summary

AccessConstructor and Description
protected
MediaType(String type, String subtype, @Nullable Charset charset)

protected

Method Summary

Modifier and TypeMethod and Description
public static MediaType

Returns:

the media type
create
(String
the type; never null or blank
type
,
String
the subtype; never null or blank
subtype
)

Create a media type with the given type and subtype.

public static MediaType

Returns:

the media type
create
(String
the type; never null or blank
type
,
String
the subtype; never null or blank
subtype
,
Charset
the charset; never null
charset
)

Create a media type with the given type, subtype, and charset.

public final boolean
equals(Object obj)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

public final int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public static MediaType

Returns:

the parsed media type
parse
(String
the media type value to parse; never null or blank
value
)

Parse the given media type value.

public final String

Returns:

a string representation of this media type
toString
()

Overrides java.lang.Object.toString.

Returns a string representation of this media type.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

APPLICATION_JSONback to summary
public static final MediaType APPLICATION_JSON

The application/json media type.

APPLICATION_OCTET_STREAMback to summary
public static final MediaType APPLICATION_OCTET_STREAM

The application/octet-stream media type.

IMAGE_JPEGback to summary
public static final MediaType IMAGE_JPEG

The image/jpeg media type.

IMAGE_PNGback to summary
public static final MediaType IMAGE_PNG

The image/png media type.

PATTERNback to summary
private static final Pattern PATTERN
TEXT_PLAINback to summary
public static final MediaType TEXT_PLAIN

The text/plain media type.

TEXT_PLAIN_UTF_8back to summary
public static final MediaType TEXT_PLAIN_UTF_8

The text/plain; charset=UTF-8 media type.

valueback to summary
private final String value

Constructor Detail

MediaTypeback to summary
protected MediaType(String type, String subtype, @Nullable Charset charset)
MediaTypeback to summary
protected MediaType(String value)

Method Detail

createback to summary
public static MediaType create(String type, String subtype)

Create a media type with the given type and subtype.

Parameters
type:String

the type; never null or blank

subtype:String

the subtype; never null or blank

Returns:MediaType

the media type

createback to summary
public static MediaType create(String type, String subtype, Charset charset)

Create a media type with the given type, subtype, and charset.

Parameters
type:String

the type; never null or blank

subtype:String

the subtype; never null or blank

charset:Charset

the charset; never null

Returns:MediaType

the media type

equalsback to summary
public final boolean equals(Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Annotations
@Override
hashCodeback to summary
public final int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Annotations
@Override
parseback to summary
public static MediaType parse(String value)

Parse the given media type value.

Must be valid according to RFC 2045.

Parameters
value:String

the media type value to parse; never null or blank

Returns:MediaType

the parsed media type

toStringback to summary
public final String toString()

Overrides java.lang.Object.toString.

Returns a string representation of this media type.

Returns:String

a string representation of this media type

Annotations
@Override