Class StringMessageConverter

java.lang.Object

org.springframework.messaging.converter.AbstractMessageConverter

org.springframework.messaging.converter.StringMessageConverter

All Implemented Interfaces:

MessageConverter, SmartMessageConverter

public class StringMessageConverter
extends AbstractMessageConverter

A MessageConverter that supports MIME type "text/plain" with the payload converted to and from a String.

Since:

4.0

Author:

Rossen Stoyanchev

Field Summary

Fields inherited from class AbstractMessageConverter

logger

Constructor Summary

Constructors

Constructor	Description
StringMessageConverter()
StringMessageConverter(Charset defaultCharset)

Method Summary

Modifier and Type	Method	Description
protected Object	convertFromInternal(Message<?> message, Class<?> targetClass, @Nullable Object conversionHint)	Convert the message payload from serialized form to an Object.
protected @Nullable Object	convertToInternal(Object payload, @Nullable MessageHeaders headers, @Nullable Object conversionHint)	Convert the payload object to serialized form.
protected boolean	supports(Class<?> clazz)	Whether the given class is supported by this converter.

Methods inherited from class AbstractMessageConverter

addSupportedMimeTypes, canConvertFrom, canConvertTo, fromMessage, fromMessage, getContentTypeResolver, getDefaultContentType, getMimeType, getSerializedPayloadClass, getSupportedMimeTypes, isStrictContentTypeMatch, setContentTypeResolver, setSerializedPayloadClass, setStrictContentTypeMatch, supportsMimeType, toMessage, toMessage

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

StringMessageConverter

public StringMessageConverter()

StringMessageConverter

public StringMessageConverter(Charset defaultCharset)

Method Details

supports

protected boolean supports(Class<?> clazz)

Description copied from class: AbstractMessageConverter

Whether the given class is supported by this converter.

Specified by:

supports in class AbstractMessageConverter

Parameters:

clazz - the class to test for support

Returns:

true if supported; false otherwise

convertFromInternal

protected Object convertFromInternal(Message<?> message,
 Class<?> targetClass,
 @Nullable Object conversionHint)

Description copied from class: AbstractMessageConverter

Convert the message payload from serialized form to an Object.

Overrides:

convertFromInternal in class AbstractMessageConverter

Parameters:

message - the input message

targetClass - the target class for the conversion

conversionHint - an extra object passed to the MessageConverter, for example, the associated MethodParameter (may be null)

Returns:

the result of the conversion, or null if the converter cannot perform the conversion

convertToInternal

protected @Nullable Object convertToInternal(Object payload,
 @Nullable MessageHeaders headers,
 @Nullable Object conversionHint)

Description copied from class: AbstractMessageConverter

Convert the payload object to serialized form.

Overrides:

convertToInternal in class AbstractMessageConverter

Parameters:

payload - the Object to convert

headers - optional headers for the message (may be null)

conversionHint - an extra object passed to the MessageConverter, for example, the associated MethodParameter (may be null)

Returns:

the resulting payload for the message, or null if the converter cannot perform the conversion