ContentType (Nimbus Content Type v2.2)

java.lang.Object
- com.nimbusds.common.contenttype.ContentType

public final class ContentType
extends Object

Content (media) type.

To create a new content type application/json without character set parameter:

 ContentType ct = new ContentType("application", "json");

 // Prints out "application/json"
 System.out.println(ct.toString());

With a character set parameter application/json; charset=UTF-8:

 ContentType ct = new ContentType("application", "json", new ContentType.Parameter("charset", "UTF-8"));

 // Prints out "application/json; charset=UTF-8"
 System.out.println(ct.toString());

To parse a content type:

 try {
         ContentType.parse("application/json; charset=UTF-8");
 } catch (java.text.ParseException e) {
         System.err.println(e.getMessage());
 }

See RFC 2045, section 5.1.

Author:: vd

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ContentType.Parameter
Optional content type parameter, for example charset=UTF-8.

Nested Classes
Modifier and Type	Class and Description
`static class`	`ContentType.Parameter` Optional content type parameter, for example `charset=UTF-8`.

Field Summary

Fields
Modifier and Type	Field and Description
`static ContentType`	`APPLICATION_JOSE` Content type `application/jose; charset=UTF-8`.
`static ContentType`	`APPLICATION_JSON` Content type `application/json; charset=UTF-8`.
`static ContentType`	`APPLICATION_JWT` Content type `application/jwt; charset=UTF-8`.
`static ContentType`	`APPLICATION_PDF` Content type `application/pdf`.
`static ContentType`	`APPLICATION_URLENCODED` Content type `application/x-www-form-urlencoded; charset=UTF-8`.
`static ContentType`	`IMAGE_APNG` Content type `image/apng`.
`static ContentType`	`IMAGE_AVIF` Content type `image/avif`.
`static ContentType`	`IMAGE_GIF` Content type `image/gif`.
`static ContentType`	`IMAGE_JPEG` Content type `image/jpeg`.
`static ContentType`	`IMAGE_PNG` Content type `image/png`.
`static ContentType`	`IMAGE_SVG_XML` Content type `image/svg+xml`.
`static ContentType`	`IMAGE_WEBP` Content type `image/webp`.
`static ContentType`	`TEXT_PLAIN` Content type `text/plain; charset=UTF-8`.

Constructor Summary

Constructors
Constructor and Description
`ContentType(String baseType, String subType, Charset charset)` Creates a new content type with the specified character set.
`ContentType(String baseType, String subType, ContentType.Parameter... param)` Creates a new content type.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`String`	`getBaseType()` Returns the base type.
`List<ContentType.Parameter>`	`getParameters()` Returns the optional parameters.
`String`	`getSubType()` Returns the subtype.
`String`	`getType()` Returns the type.
`int`	`hashCode()`
`boolean`	`matches(ContentType other)` Returns `true` if the types and subtypes match.
`static ContentType`	`parse(String s)` Parses a content type from the specified string.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - APPLICATION_JSON
```
public static final ContentType APPLICATION_JSON
```
    Content type application/json; charset=UTF-8.
  - APPLICATION_JOSE
```
public static final ContentType APPLICATION_JOSE
```
    Content type application/jose; charset=UTF-8.
  - APPLICATION_JWT
```
public static final ContentType APPLICATION_JWT
```
    Content type application/jwt; charset=UTF-8.
  - APPLICATION_URLENCODED
```
public static final ContentType APPLICATION_URLENCODED
```
    Content type application/x-www-form-urlencoded; charset=UTF-8.
  - TEXT_PLAIN
```
public static final ContentType TEXT_PLAIN
```
    Content type text/plain; charset=UTF-8.
  - IMAGE_APNG
```
public static final ContentType IMAGE_APNG
```
    Content type image/apng.
  - IMAGE_AVIF
```
public static final ContentType IMAGE_AVIF
```
    Content type image/avif.
  - IMAGE_GIF
```
public static final ContentType IMAGE_GIF
```
    Content type image/gif.
  - IMAGE_JPEG
```
public static final ContentType IMAGE_JPEG
```
    Content type image/jpeg.
  - IMAGE_PNG
```
public static final ContentType IMAGE_PNG
```
    Content type image/png.
  - IMAGE_SVG_XML
```
public static final ContentType IMAGE_SVG_XML
```
    Content type image/svg+xml.
  - IMAGE_WEBP
```
public static final ContentType IMAGE_WEBP
```
    Content type image/webp.
  - APPLICATION_PDF
```
public static final ContentType APPLICATION_PDF
```
    Content type application/pdf.
- Constructor Detail
  - ContentType
```
public ContentType(String baseType,
                   String subType,
                   ContentType.Parameter... param)
```
    Creates a new content type.
    
    Parameters:
    
    baseType - The type. E.g. "application" from "application/json".Must not be null or empty.
    
    subType - The subtype. E.g. "json" from "application/json". Must not be null or empty.
    
    param - Optional parameters.
  - ContentType
```
public ContentType(String baseType,
                   String subType,
                   Charset charset)
```
    Creates a new content type with the specified character set.
    
    Parameters:
    
    baseType - The base type. E.g. "application" from "application/json".Must not be null or empty.
    
    subType - The subtype. E.g. "json" from "application/json". Must not be null or empty.
    
    charset - The character set to use for the charset parameter. Must not be null.
- Method Detail
  - getBaseType
```
public String getBaseType()
```
    Returns the base type. E.g. "application" from "application/json".
    
    Returns:
    
    The base type.
  - getSubType
```
public String getSubType()
```
    Returns the subtype. E.g. "json" from "application/json".
    
    Returns:
    
    The subtype.
  - getType
```
public String getType()
```
    Returns the type. E.g. "application/json".
    
    Returns:
    
    The type, any optional parameters are omitted.
  - getParameters
```
public List<ContentType.Parameter> getParameters()
```
    Returns the optional parameters.
    
    Returns:
    
    The parameters, as unmodifiable list, empty list if none.
  - matches
```
public boolean matches(ContentType other)
```
    Returns true if the types and subtypes match. The parameters, if any, are ignored.
    
    Parameters:
    
    other - The other content type, null if not specified.
    
    Returns:
    
    true if the types and subtypes match, else false.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - parse
```
public static ContentType parse(String s)
                         throws ParseException
```
    Parses a content type from the specified string.
    
    Parameters:
    
    s - The string to parse.
    
    Returns:
    
    The content type.
    
    Throws:
    
    ParseException - If parsing failed or the string is null or empty.

Class ContentType

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

APPLICATION_JSON

APPLICATION_JOSE

APPLICATION_JWT

APPLICATION_URLENCODED

TEXT_PLAIN

IMAGE_APNG

IMAGE_AVIF

IMAGE_GIF

IMAGE_JPEG

IMAGE_PNG

IMAGE_SVG_XML

IMAGE_WEBP

APPLICATION_PDF

Constructor Detail

ContentType

ContentType

Method Detail

getBaseType

getSubType

getType

getParameters

matches

toString

equals

hashCode

parse