Package ratpack.core.http

Interface MediaType

  • public interface MediaType
    A structured value for a Content-Type header value.

    Can also represent a non existent (i.e. empty) value.

    • Method Detail

      • getType

        @Nullable
String getType()
        The type without parameters.

        Given a mime type of "text/plain;charset=utf-8", returns "text/plain".

        May be null to represent no content type.

        Returns:
        The mime type without parameters, or null if this represents the absence of a value.

      • getParams

        com.google.common.collect.ImmutableListMultimap<String,​String> getParams()
        The multimap containing parameters of the mime type.

        Given a mime type of "application/json;charset=utf-8", the get("charset") returns ["utf-8"]". May be empty, never null.

        All param names have been lower cased. The charset parameter values has been lower cased too.

        Returns:
        the immutable multimap of the media type params.

      • getCharset

        @Nullable
String getCharset()
        The value of the "charset" parameter.
        Returns:
        the value of the charset parameter, or null if the no charset parameter was specified

      • getCharset

        String getCharset​(String defaultValue)
        The value of the "charset" parameter, or the given default value of no charset was specified.
        Parameters:
        defaultValue - the value if this type has no charset
        Returns:
        the value of the charset parameter, or the given default

      • isText

        boolean isText()
        True if this type starts with "text/".
        Returns:
        True if this type starts with "text/".

      • isJson

        boolean isJson()
        True if this type equals "application/json", or ends with "+json".
        Returns:
        if this represents a JSON like type

      • isHtml

        boolean isHtml()
        True if this type equals "text/html".
        Returns:
        True if this type equals "text/html".

      • isEmpty

        boolean isEmpty()
        True if this represents the absence of a value (i.e. no Content-Type header)
        Returns:
        True if this represents the absence of a value (i.e. no Content-Type header)