org.springframework.http.converter

Interface HttpMessageConverter<T>

    • Method Detail

      • canRead

        boolean canRead(java.lang.Class<?> clazz,
                        @Nullable
                        MediaType mediaType)
        Indicates whether the given class can be read by this converter.
        Parameters:
        clazz - the class to test for readability
        mediaType - the media type to read (can be null if not specified); typically the value of a Content-Type header.
        Returns:
        true if readable; false otherwise
      • canWrite

        boolean canWrite(java.lang.Class<?> clazz,
                         @Nullable
                         MediaType mediaType)
        Indicates whether the given class can be written by this converter.
        Parameters:
        clazz - the class to test for writability
        mediaType - the media type to write (can be null if not specified); typically the value of an Accept header.
        Returns:
        true if writable; false otherwise
      • getSupportedMediaTypes

        java.util.List<MediaType> getSupportedMediaTypes()
        Return the list of MediaType objects supported by this converter.
        Returns:
        the list of supported media types
      • read

        T read(java.lang.Class<? extends T> clazz,
               HttpInputMessage inputMessage)
        throws java.io.IOException,
               HttpMessageNotReadableException
        Read an object of the given type from the given input message, and returns it.
        Parameters:
        clazz - the type of object to return. This type must have previously been passed to the canRead method of this interface, which must have returned true.
        inputMessage - the HTTP input message to read from
        Returns:
        the converted object
        Throws:
        java.io.IOException - in case of I/O errors
        HttpMessageNotReadableException - in case of conversion errors
      • write

        void write(T t,
                   @Nullable
                   MediaType contentType,
                   HttpOutputMessage outputMessage)
            throws java.io.IOException,
                   HttpMessageNotWritableException
        Write an given object to the given output message.
        Parameters:
        t - the object to write to the output message. The type of this object must have previously been passed to the canWrite method of this interface, which must have returned true.
        contentType - the content type to use when writing. May be null to indicate that the default content type of the converter must be used. If not null, this media type must have previously been passed to the canWrite method of this interface, which must have returned true.
        outputMessage - the message to write to
        Throws:
        java.io.IOException - in case of I/O errors
        HttpMessageNotWritableException - in case of conversion errors