public class StringHttpMessageConverter extends AbstractHttpMessageConverter<java.lang.String>
HttpMessageConverter
that can read and write strings.
By default, this converter supports all media types (*/*
),
and writes with a Content-Type
of text/plain
. This can be overridden
by setting the supportedMediaTypes
property.
Modifier and Type | Field and Description |
---|---|
static java.nio.charset.Charset |
DEFAULT_CHARSET |
logger
Constructor and Description |
---|
StringHttpMessageConverter()
A default constructor that uses
"ISO-8859-1" as the default charset. |
StringHttpMessageConverter(java.nio.charset.Charset defaultCharset)
A constructor accepting a default charset to use if the requested content
type does not specify one.
|
Modifier and Type | Method and Description |
---|---|
protected java.util.List<java.nio.charset.Charset> |
getAcceptedCharsets()
Return the list of supported
Charset s. |
protected java.lang.Long |
getContentLength(java.lang.String str,
MediaType contentType)
Returns the content length for the given type.
|
protected java.lang.String |
readInternal(java.lang.Class<? extends java.lang.String> clazz,
HttpInputMessage inputMessage)
Abstract template method that reads the actual object.
|
void |
setWriteAcceptCharset(boolean writeAcceptCharset)
Indicates whether the
Accept-Charset should be written to any outgoing request. |
boolean |
supports(java.lang.Class<?> clazz)
Indicates whether the given class is supported by this converter.
|
protected void |
writeInternal(java.lang.String str,
HttpOutputMessage outputMessage)
Abstract template method that writes the actual body.
|
addDefaultHeaders, canRead, canRead, canWrite, canWrite, getDefaultCharset, getDefaultContentType, getSupportedMediaTypes, read, setDefaultCharset, setSupportedMediaTypes, write
public StringHttpMessageConverter()
"ISO-8859-1"
as the default charset.StringHttpMessageConverter(Charset)
public StringHttpMessageConverter(java.nio.charset.Charset defaultCharset)
public void setWriteAcceptCharset(boolean writeAcceptCharset)
Accept-Charset
should be written to any outgoing request.
Default is true
.
public boolean supports(java.lang.Class<?> clazz)
AbstractHttpMessageConverter
supports
in class AbstractHttpMessageConverter<java.lang.String>
clazz
- the class to test for supporttrue
if supported; false
otherwiseprotected java.lang.String readInternal(java.lang.Class<? extends java.lang.String> clazz, HttpInputMessage inputMessage) throws java.io.IOException
AbstractHttpMessageConverter
AbstractHttpMessageConverter.read(java.lang.Class<? extends T>, org.springframework.http.HttpInputMessage)
.readInternal
in class AbstractHttpMessageConverter<java.lang.String>
clazz
- the type of object to returninputMessage
- the HTTP input message to read fromjava.io.IOException
- in case of I/O errorsprotected java.lang.Long getContentLength(java.lang.String str, @Nullable MediaType contentType)
AbstractHttpMessageConverter
By default, this returns null
, meaning that the content length is unknown.
Can be overridden in subclasses.
getContentLength
in class AbstractHttpMessageConverter<java.lang.String>
str
- the type to return the content length fornull
if not knownprotected void writeInternal(java.lang.String str, HttpOutputMessage outputMessage) throws java.io.IOException
AbstractHttpMessageConverter
AbstractHttpMessageConverter.write(T, org.springframework.http.MediaType, org.springframework.http.HttpOutputMessage)
.writeInternal
in class AbstractHttpMessageConverter<java.lang.String>
str
- the object to write to the output messageoutputMessage
- the HTTP output message to write tojava.io.IOException
- in case of I/O errorsprotected java.util.List<java.nio.charset.Charset> getAcceptedCharsets()
Charset
s.
By default, returns Charset.availableCharsets()
.
Can be overridden in subclasses.