com.helger.commons.typeconvert.rule

Class TypeConverterRuleFixedSourceAssignableDestination<SRC,DST>

java.lang.Object

com.helger.commons.typeconvert.rule.AbstractTypeConverterRule<SRC,DST>

com.helger.commons.typeconvert.rule.TypeConverterRuleFixedSourceAssignableDestination<SRC,DST>

Type Parameters:

SRC - Source type

DST - Destination type

All Implemented Interfaces:

ITypeConverter<SRC,DST>, ITypeConverterRule<SRC,DST>, Function<SRC,DST>

public class TypeConverterRuleFixedSourceAssignableDestination<SRC,DST>
extends AbstractTypeConverterRule<SRC,DST>

Abstract type converter than can convert from a base source class to a destination class. Example from String.class to specific Enum.class

Author:

Philip Helger

Nested Class Summary

Nested classes/interfaces inherited from interface com.helger.commons.typeconvert.ITypeConverterRule

ITypeConverterRule.ESubType

Constructor Summary

Constructors

Constructor and Description
TypeConverterRuleFixedSourceAssignableDestination(Class<SRC> aSrcClass, Class<DST> aDstClass, Function<SRC,DST> aConverter)

Method Summary

Modifier and Type	Method and Description
DST	apply(SRC aSource) Convert the passed source object to the destination type.
boolean	canConvert(Class<?> aSrcClass, Class<?> aDstClass) Check if this converter can handle the conversion from the passed source to the passed destination class.
Class<DST>	getDestinationClass()
Class<SRC>	getSourceClass()
String	toString()

Methods inherited from class com.helger.commons.typeconvert.rule.AbstractTypeConverterRule

getSubType

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.Function

andThen, compose, identity

Constructor Detail

TypeConverterRuleFixedSourceAssignableDestination

public TypeConverterRuleFixedSourceAssignableDestination(@Nonnull
                                                         Class<SRC> aSrcClass,
                                                         @Nonnull
                                                         Class<DST> aDstClass,
                                                         @Nonnull
                                                         Function<SRC,DST> aConverter)

Method Detail

canConvert

public final boolean canConvert(@Nonnull
                                Class<?> aSrcClass,
                                @Nonnull
                                Class<?> aDstClass)

Description copied from interface: ITypeConverterRule

Check if this converter can handle the conversion from the passed source to the passed destination class. Note: as this method is called for every type conversion for which no exact converters are present, the implementation of this method should be as efficient as possible.

Parameters:

aSrcClass - Source class to convert from. Never null.

aDstClass - Destination class to convert to. Never null.

Returns:

true if conversion is possible, false otherwise.

getSourceClass

@Nonnull
public final Class<SRC> getSourceClass()

getDestinationClass

@Nonnull
public final Class<DST> getDestinationClass()

apply

@Nullable
public DST apply(@Nonnull
                            SRC aSource)

Description copied from interface: ITypeConverter

Convert the passed source object to the destination type.

Parameters:

aSource - The source object to be converted. Cannot be null because the type converter already filters null values!

Returns:

The converted value. May be null.

toString

public String toString()

Overrides:

toString in class AbstractTypeConverterRule<SRC,DST>