Package org.mapstruct.ap.internal.conversion

Class SimpleConversion

java.lang.Object
org.mapstruct.ap.internal.conversion.SimpleConversion
All Implemented Interfaces:
ConversionProvider
Direct Known Subclasses:
AbstractJavaTimeToStringConversion, AbstractJodaTypeToStringConversion, AbstractNumberToStringConversion, BigDecimalToBigIntegerConversion, BigDecimalToPrimitiveConversion, BigDecimalToWrapperConversion, BigIntegerToPrimitiveConversion, BigIntegerToWrapperConversion, CharToStringConversion, CharWrapperToStringConversion, CurrencyToStringConversion, DateToSqlDateConversion, DateToSqlTimeConversion, DateToSqlTimestampConversion, EnumStringConversion, EnumToIntegerConversion, JavaInstantToDateConversion, JavaLocalDateTimeToDateConversion, JavaLocalDateTimeToLocalDateConversion, JavaLocalDateToDateConversion, JavaLocalDateToSqlDateConversion, JavaZonedDateTimeToDateConversion, JodaDateTimeToCalendarConversion, JodaTimeToDateConversion, LocaleToStringConversion, PrimitiveToPrimitiveConversion, PrimitiveToWrapperConversion, StaticParseToStringConversion, StringBuilderToStringConversion, TypeToOptionalConversion, URLToStringConversion, UUIDToStringConversion, WrapperToWrapperConversion
public abstract class SimpleConversion extends Object implements ConversionProvider
Base class for ConversionProviders creating TypeConversions which don't declare any exception types.
Author:
Gunnar Morling

  • Constructor Details

    • SimpleConversion

      public SimpleConversion()

  • Method Details

    • to

      public Assignment to(ConversionContext conversionContext)
      Description copied from interface: ConversionProvider
      Creates the conversion from source to target of a property mapping.
      Specified by:
      to in interface ConversionProvider
      Parameters:
      conversionContext - ConversionContext providing optional information required for creating the conversion.
      Returns:
      A conversion from source to target.

    • from

      public Assignment from(ConversionContext conversionContext)
      Description copied from interface: ConversionProvider
      Creates the conversion from target to source of a property mapping.
      Specified by:
      from in interface ConversionProvider
      Parameters:
      conversionContext - ConversionContext providing optional information required for creating the conversion.
      Returns:
      A conversion from target to source.

    • getRequiredHelperMethods

      public List<HelperMethod> getRequiredHelperMethods(ConversionContext conversionContext)
      Description copied from interface: ConversionProvider
      Retrieves any helper methods required for creating the conversion.
      Specified by:
      getRequiredHelperMethods in interface ConversionProvider
      Parameters:
      conversionContext - ConversionContext providing optional information required for creating the conversion.
      Returns:
      any helper methods when required.

    • getToExpression

      protected abstract String getToExpression(ConversionContext conversionContext)
      Returns the conversion string from source to target. The placeholder <SOURCE> can be used to represent a reference to the source value.
      Parameters:
      conversionContext - A context providing optional information required for creating the conversion.
      Returns:
      The conversion string from source to target

    • getFromExpression

      protected abstract String getFromExpression(ConversionContext conversionContext)
      Returns the conversion string from target to source. The placeholder <SOURCE> can be used to represent a reference to the target value.
      Parameters:
      conversionContext - ConversionContext providing optional information required for creating the conversion.
      Returns:
      The conversion string from target to source

    • getFromConversionImportTypes

      protected Set<Type> getFromConversionImportTypes(ConversionContext conversionContext)
      Returns a set with imported types of the "from" conversion. Defaults to an empty set; can be overridden in sub-classes to return the required types.
      Parameters:
      conversionContext - the conversion context
      Returns:
      conversion types required in the "from" conversion

    • getToConversionImportTypes

      protected Set<Type> getToConversionImportTypes(ConversionContext conversionContext)
      Returns a set with imported types of the "to" conversion. Defaults to an empty set; can be overridden in sub-classes to return the required types.
      Parameters:
      conversionContext - the conversion context
      Returns:
      conversion types required in the "to" conversion

    • getToConversionExceptionTypes

      protected List<Type> getToConversionExceptionTypes(ConversionContext conversionContext)

    • getFromConversionExceptionTypes

      protected List<Type> getFromConversionExceptionTypes(ConversionContext conversionContext)