org.springframework.http.converter
Class StringHttpMessageConverter

java.lang.Object
  extended by org.springframework.http.converter.AbstractHttpMessageConverter<String>
      extended by org.springframework.http.converter.StringHttpMessageConverter
All Implemented Interfaces:
HttpMessageConverter<String>

public class StringHttpMessageConverter
extends AbstractHttpMessageConverter<String>

Implementation of HttpMessageConverter that can read and write strings.

By default, this converter supports all text media types (text/*), and writes with a Content-Type of text/plain. This can be overridden by setting the supportedMediaTypes property.

Since:
3.0
Author:
Arjen Poutsma

Field Summary
static Charset DEFAULT_CHARSET
           
 
Fields inherited from class org.springframework.http.converter.AbstractHttpMessageConverter
logger
 
Constructor Summary
StringHttpMessageConverter()
           
 
Method Summary
protected  List<Charset> getAcceptedCharsets()
          Return the list of supported Charset.
protected  Long getContentLength(String s)
          Returns the content length for the given type.
 String readInternal(Class<String> clazz, HttpInputMessage inputMessage)
          Abstract template method that reads the actualy object.
 boolean supports(Class<? extends String> clazz)
          Indicate whether the given class is supported by this converter.
protected  void writeInternal(String s, HttpOutputMessage outputMessage)
          Abstract template method that writes the actual body.
 
Methods inherited from class org.springframework.http.converter.AbstractHttpMessageConverter
getContentType, getSupportedMediaTypes, read, setSupportedMediaTypes, write
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DEFAULT_CHARSET

public static final Charset DEFAULT_CHARSET
Constructor Detail

StringHttpMessageConverter

public StringHttpMessageConverter()
Method Detail

supports

public boolean supports(Class<? extends String> clazz)
Description copied from interface: HttpMessageConverter
Indicate whether the given class is supported by this converter.

Parameters:
clazz - the class to test for support
Returns:
true if supported; false otherwise

readInternal

public String readInternal(Class<String> clazz,
                           HttpInputMessage inputMessage)
                    throws IOException
Description copied from class: AbstractHttpMessageConverter
Abstract template method that reads the actualy object. Invoked from AbstractHttpMessageConverter.read(Class, HttpInputMessage).

Specified by:
readInternal in class AbstractHttpMessageConverter<String>
Parameters:
clazz - the type of object to return
inputMessage - the HTTP input message to read from
Returns:
the converted object
Throws:
IOException - in case of I/O errors

getContentLength

protected Long getContentLength(String s)
Description copied from class: AbstractHttpMessageConverter
Returns the content length for the given type.

By default, this returns null. Can be overriden in subclasses.

Overrides:
getContentLength in class AbstractHttpMessageConverter<String>
Parameters:
s - the type to return the content length for
Returns:
the content length, or null if not known

writeInternal

protected void writeInternal(String s,
                             HttpOutputMessage outputMessage)
                      throws IOException
Description copied from class: AbstractHttpMessageConverter
Abstract template method that writes the actual body. Invoked from AbstractHttpMessageConverter.write(Object, HttpOutputMessage).

Specified by:
writeInternal in class AbstractHttpMessageConverter<String>
Parameters:
s - the object to write to the output message
outputMessage - the message to write to
Throws:
IOException - in case of I/O errors

getAcceptedCharsets

protected List<Charset> getAcceptedCharsets()
Return the list of supported Charset.

By default, returns Charset.availableCharsets(). Can be overridden in subclasses.

Returns:
the list of accepted charsets