java.lang.Object
- org.springframework.http.converter.AbstractHttpMessageConverter<T>
- - org.springframework.http.converter.AbstractGenericHttpMessageConverter<T>

All Implemented Interfaces:
GenericHttpMessageConverter<T>, HttpMessageConverter<T>
Direct Known Subclasses:
AbstractJackson2HttpMessageConverter, GsonHttpMessageConverter, ResourceRegionHttpMessageConverter
```
public abstract class AbstractGenericHttpMessageConverter<T>
extends AbstractHttpMessageConverter<T>
implements GenericHttpMessageConverter<T>
```
Abstract base class for most GenericHttpMessageConverter implementations.
Since:
4.2
Author:
Sebastien Deleuze, Juergen Hoeller

Field Summary
- Fields inherited from class org.springframework.http.converter.AbstractHttpMessageConverter
  logger

Constructor Summary

Constructors
Modifier	Constructor	Description
`protected`	`AbstractGenericHttpMessageConverter()`	Construct an `AbstractGenericHttpMessageConverter` with no supported media types.
`protected`	`AbstractGenericHttpMessageConverter(MediaType supportedMediaType)`	Construct an `AbstractGenericHttpMessageConverter` with one supported media type.
`protected`	`AbstractGenericHttpMessageConverter(MediaType... supportedMediaTypes)`	Construct an `AbstractGenericHttpMessageConverter` with multiple supported media type.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`canRead(Type type, Class<?> contextClass, MediaType mediaType)`	Indicates whether the given type can be read by this converter.
`boolean`	`canWrite(Type type, Class<?> clazz, MediaType mediaType)`	Indicates whether the given class can be written by this converter.
`protected boolean`	`supports(Class<?> clazz)`	Indicates whether the given class is supported by this converter.
`void`	`write(T t, Type type, MediaType contentType, HttpOutputMessage outputMessage)`	This implementation sets the default headers by calling `AbstractHttpMessageConverter.addDefaultHeaders(org.springframework.http.HttpHeaders, T, org.springframework.http.MediaType)`, and then calls `writeInternal(T, org.springframework.http.HttpOutputMessage)`.
`protected abstract void`	`writeInternal(T t, Type type, HttpOutputMessage outputMessage)`	Abstract template method that writes the actual body.
`protected void`	`writeInternal(T t, HttpOutputMessage outputMessage)`	Abstract template method that writes the actual body.

Methods inherited from class org.springframework.http.converter.AbstractHttpMessageConverter
addDefaultHeaders, canRead, canRead, canWrite, canWrite, getContentLength, getDefaultCharset, getDefaultContentType, getSupportedMediaTypes, read, readInternal, setDefaultCharset, setSupportedMediaTypes, write

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

Methods inherited from interface org.springframework.http.converter.GenericHttpMessageConverter
read

Methods inherited from interface org.springframework.http.converter.HttpMessageConverter
canRead, canWrite, getSupportedMediaTypes, read, write

- Constructor Detail
  - AbstractGenericHttpMessageConverter
```
protected AbstractGenericHttpMessageConverter()
```
    Construct an AbstractGenericHttpMessageConverter with no supported media types.
    See Also:
    AbstractHttpMessageConverter.setSupportedMediaTypes(java.util.List<org.springframework.http.MediaType>)
  - AbstractGenericHttpMessageConverter
```
protected AbstractGenericHttpMessageConverter(MediaType supportedMediaType)
```
    Construct an AbstractGenericHttpMessageConverter with one supported media type.
    Parameters:
    supportedMediaType - the supported media type
  - AbstractGenericHttpMessageConverter
```
protected AbstractGenericHttpMessageConverter(MediaType... supportedMediaTypes)
```
    Construct an AbstractGenericHttpMessageConverter with multiple supported media type.
    Parameters:
    supportedMediaTypes - the supported media types
- Method Detail
  - supports
```
protected boolean supports(Class<?> clazz)
```
    Description copied from class: AbstractHttpMessageConverter
    Indicates whether the given class is supported by this converter.
    Specified by:
    supports in class AbstractHttpMessageConverter<T>
    Parameters:
    clazz - the class to test for support
    Returns:
    true if supported; false otherwise
  - canRead
```
public boolean canRead(Type type,
                       Class<?> contextClass,
                       MediaType mediaType)
```
    Description copied from interface: GenericHttpMessageConverter
    Indicates whether the given type can be read by this converter. This method should perform the same checks than HttpMessageConverter.canRead(Class, MediaType) with additional ones related to the generic type.
    Specified by:
    canRead in interface GenericHttpMessageConverter<T>
    Parameters:
    type - the (potentially generic) type to test for readability
    contextClass - a context class for the target type, for example a class in which the target type appears in a method signature (can be null)
    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
```
public boolean canWrite(Type type,
                        Class<?> clazz,
                        MediaType mediaType)
```
    Description copied from interface: GenericHttpMessageConverter
    Indicates whether the given class can be written by this converter.
    This method should perform the same checks than HttpMessageConverter.canWrite(Class, MediaType) with additional ones related to the generic type.
    Specified by:
    canWrite in interface GenericHttpMessageConverter<T>
    Parameters:
    type - the (potentially generic) type to test for writability (can be null if not specified)
    clazz - the source object 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
  - write
```
public final void write(T t,
                        Type type,
                        MediaType contentType,
                        HttpOutputMessage outputMessage)
                 throws IOException,
                        HttpMessageNotWritableException
```
    This implementation sets the default headers by calling AbstractHttpMessageConverter.addDefaultHeaders(org.springframework.http.HttpHeaders, T, org.springframework.http.MediaType), and then calls writeInternal(T, org.springframework.http.HttpOutputMessage).
    Specified by:
    write in interface GenericHttpMessageConverter<T>
    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.
    type - the (potentially generic) type of object to write. This type must have previously been passed to the canWrite method of this interface, which must have returned true. Can be null if not specified.
    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:
    IOException - in case of I/O errors
    HttpMessageNotWritableException - in case of conversion errors
  - writeInternal
```
protected void writeInternal(T t,
                             HttpOutputMessage outputMessage)
                      throws IOException,
                             HttpMessageNotWritableException
```
    Description copied from class: AbstractHttpMessageConverter
    Abstract template method that writes the actual body. Invoked from AbstractHttpMessageConverter.write(T, org.springframework.http.MediaType, org.springframework.http.HttpOutputMessage).
    Specified by:
    writeInternal in class AbstractHttpMessageConverter<T>
    Parameters:
    t - the object to write to the output message
    outputMessage - the HTTP output message to write to
    Throws:
    IOException - in case of I/O errors
    HttpMessageNotWritableException - in case of conversion errors
  - writeInternal
```
protected abstract void writeInternal(T t,
                                      Type type,
                                      HttpOutputMessage outputMessage)
                               throws IOException,
                                      HttpMessageNotWritableException
```
    Abstract template method that writes the actual body. Invoked from write(T, java.lang.reflect.Type, org.springframework.http.MediaType, org.springframework.http.HttpOutputMessage).
    Parameters:
    t - the object to write to the output message
    type - the type of object to write (may be null)
    outputMessage - the HTTP output message to write to
    Throws:
    IOException - in case of I/O errors
    HttpMessageNotWritableException - in case of conversion errors

Class AbstractGenericHttpMessageConverter<T>

Field Summary

Fields inherited from class org.springframework.http.converter.AbstractHttpMessageConverter

Constructor Summary

Method Summary

Methods inherited from class org.springframework.http.converter.AbstractHttpMessageConverter

Methods inherited from class java.lang.Object

Methods inherited from interface org.springframework.http.converter.GenericHttpMessageConverter

Methods inherited from interface org.springframework.http.converter.HttpMessageConverter

Constructor Detail

AbstractGenericHttpMessageConverter

AbstractGenericHttpMessageConverter

AbstractGenericHttpMessageConverter

Method Detail

supports

canRead

canWrite

write

writeInternal

writeInternal