org.springframework.core.convert.support

Class StreamConverter

java.lang.Object

org.springframework.core.convert.support.StreamConverter

All Implemented Interfaces:

ConditionalConverter, ConditionalGenericConverter, GenericConverter

@UsesJava8
public class StreamConverter
extends Object
implements ConditionalGenericConverter

Converts a Stream to and from a collection or array, converting the element type if necessary.

Since:

4.2

Author:

Stephane Nicoll

Nested Class Summary

Nested classes/interfaces inherited from interface org.springframework.core.convert.converter.GenericConverter

GenericConverter.ConvertiblePair

Constructor Summary

Constructors

Constructor and Description
StreamConverter(ConversionService conversionService)

Method Summary

Modifier and Type	Method and Description
Object	convert(Object source, TypeDescriptor sourceType, TypeDescriptor targetType) Convert the source object to the targetType described by the TypeDescriptor.
Set<GenericConverter.ConvertiblePair>	getConvertibleTypes() Return the source and target types that this converter can convert between.
boolean	matches(TypeDescriptor sourceType, TypeDescriptor targetType) Should the conversion from sourceType to targetType currently under consideration be selected?
boolean	matchesFromStream(TypeDescriptor elementType, TypeDescriptor targetType) Validate that a Collection of the elements held within the stream can be converted to the specified targetType.
boolean	matchesToStream(TypeDescriptor elementType, TypeDescriptor sourceType) Validate that the specified sourceType can be converted to a Collection of the type of the stream elements.

Methods inherited from class java.lang.Object

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

Constructor Detail

StreamConverter

public StreamConverter(ConversionService conversionService)

Method Detail

getConvertibleTypes

public Set<GenericConverter.ConvertiblePair> getConvertibleTypes()

Description copied from interface: GenericConverter

Return the source and target types that this converter can convert between.

Each entry is a convertible source-to-target type pair.

For conditional converters this method may return null to indicate all source-to-target pairs should be considered.

Specified by:

getConvertibleTypes in interface GenericConverter

matches

public boolean matches(TypeDescriptor sourceType,
                       TypeDescriptor targetType)

Description copied from interface: ConditionalConverter

Should the conversion from sourceType to targetType currently under consideration be selected?

Specified by:

matches in interface ConditionalConverter

Parameters:

sourceType - the type descriptor of the field we are converting from

targetType - the type descriptor of the field we are converting to

Returns:

true if conversion should be performed, false otherwise

matchesFromStream

public boolean matchesFromStream(TypeDescriptor elementType,
                                 TypeDescriptor targetType)

Validate that a Collection of the elements held within the stream can be converted to the specified targetType.

Parameters:

elementType - the type of the stream elements

targetType - the type to convert to

matchesToStream

public boolean matchesToStream(TypeDescriptor elementType,
                               TypeDescriptor sourceType)

Validate that the specified sourceType can be converted to a Collection of the type of the stream elements.

Parameters:

elementType - the type of the stream elements

sourceType - the type to convert from

convert

public Object convert(Object source,
                      TypeDescriptor sourceType,
                      TypeDescriptor targetType)

Description copied from interface: GenericConverter

Convert the source object to the targetType described by the TypeDescriptor.

Specified by:

convert in interface GenericConverter

Parameters:

source - the source object to convert (may be null)

sourceType - the type descriptor of the field we are converting from

targetType - the type descriptor of the field we are converting to

Returns:

the converted object