third_codes/mapstruct
1
0
Fork 0
mirror of https://github.com/mapstruct/mapstruct.git synced 2025-07-12 00:00:08 +08:00
Code Issues Packages Projects Releases Wiki Activity

#2169 Add support for defining a custom unexpected value mapping exception

Browse Source 
Expose definition via:

* `@EnumMapping`
* `@Mapper`
* `@MapperConfig`
* `EnumMappingStrategy` SPI

Rename `EnumNamingStrategy` to `EnumMappingStrategy`
This commit is contained in:
Filip Hrisafov 2020-08-29 13:53:30 +02:00 committed by GitHub
parent a9451b1159
commit 7dcbef349d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
40 changed files with 1014 additions and 72 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
core/src/main/java/org/mapstruct/EnumMapping.java
View File

@ -111,7 +111,7 @@ public @interface EnumMapping {
*
* @return the name transformation strategy
*/
String nameTransformationStrategy();
String nameTransformationStrategy() default "";
/**
* The configuration that should be passed on the appropriate name transformation strategy.
@ -119,5 +119,26 @@ public @interface EnumMapping {
*
* @return the configuration to use
*/
String configuration();
String configuration() default "";
/**
* Exception that should be thrown by the generated code if no mapping matches.
* If no exception is configured, the exception given via {@link MapperConfig#unexpectedValueMappingException()} or
* {@link Mapper#unexpectedValueMappingException()} will be used, using {@link IllegalArgumentException} by default.
*
* <p>
* Note:
* <ul>
* <li>
* The defined exception should at least have a constructor with a {@link String} parameter.
* </li>
* <li>
* If the defined exception is a checked exception then the enum mapping methods should have that exception
* in the throws clause.
* </li>
* </ul>
*
* @return the exception that should be used in the generated code
*/
Class<? extends Exception> unexpectedValueMappingException() default IllegalArgumentException.class;
}

23
core/src/main/java/org/mapstruct/Mapper.java
View File

@ -296,4 +296,27 @@ public @interface Mapper {
* @see org.mapstruct.control.MappingControl
*/
Class<? extends Annotation> mappingControl() default MappingControl.class;
/**
* Exception that should be thrown by the generated code if no mapping matches for enums.
* If no exception is configured, the exception given via {@link MapperConfig#unexpectedValueMappingException()}
* will be used, using {@link IllegalArgumentException} by default.
*
* <p>
* Note:
* <ul>
* <li>
* The defined exception should at least have a constructor with a {@link String} parameter.
* </li>
* <li>
* If the defined exception is a checked exception then the enum mapping methods should have that exception
* in the throws clause.
* </li>
* </ul>
*
* @return the exception that should be used in the generated code
*
* @since 1.4
*/
Class<? extends Exception> unexpectedValueMappingException() default IllegalArgumentException.class;
}

22
core/src/main/java/org/mapstruct/MapperConfig.java
View File

@ -273,5 +273,27 @@ public @interface MapperConfig {
*/
Class<? extends Annotation> mappingControl() default MappingControl.class;
/**
* Exception that should be thrown by the generated code if no mapping matches for enums.
* If no exception is configured, {@link IllegalArgumentException} will be used by default.
*
* <p>
* Note:
* <ul>
* <li>
* The defined exception should at least have a constructor with a {@link String} parameter.
* </li>
* <li>
* If the defined exception is a checked exception then the enum mapping methods should have that exception
* in the throws clause.
* </li>
* </ul>
*
* @return the exception that should be used in the generated code
*
* @since 1.4
*/
Class<? extends Exception> unexpectedValueMappingException() default IllegalArgumentException.class;
}

8
documentation/src/main/asciidoc/chapter-13-using-mapstruct-spi.asciidoc
View File

@ -202,7 +202,7 @@ include::{processor-ap-main}/spi/NoOpBuilderProvider.java[tag=documentation]
[[custom-enum-naming-strategy]]
=== Custom Enum Naming Strategy
MapStruct offers the possibility to override the `EnumNamingStrategy` via the Service Provider Interface (SPI).
MapStruct offers the possibility to override the `EnumMappingStrategy` via the Service Provider Interface (SPI).
This can be used when you have certain enums that follow some conventions within your organization.
For example all enums which implement an interface named `CustomEnumMarker` are prefixed with `CUSTOM_`
and the default value for them when mapping from `null` is `UNSPECIFIED`
@ -250,15 +250,15 @@ public interface CheeseTypeMapper {
----
====
This can be achieved with implementing the SPI `org.mapstruct.ap.spi.EnumNamingStrategy` as in the following example.
Here’s an implemented `org.mapstruct.ap.spi.EnumNamingStrategy`:
This can be achieved with implementing the SPI `org.mapstruct.ap.spi.EnumMappingStrategy` as in the following example.
Here’s an implemented `org.mapstruct.ap.spi.EnumMappingStrategy`:
.Custom enum naming strategy
====
[source, java, linenums]
[subs="verbatim,attributes"]
----
public class CustomEnumNamingStrategy extends DefaultEnumNamingStrategy {
public class CustomEnumMappingStrategy extends DefaultEnumMappingStrategy {
@Override
public String getDefaultNullEnumConstant(TypeElement enumType) {

12
processor/src/main/java/org/mapstruct/ap/internal/model/MappingBuilderContext.java
View File

@ -30,7 +30,7 @@ import org.mapstruct.ap.internal.option.Options;
import org.mapstruct.ap.internal.util.AccessorNamingUtils;
import org.mapstruct.ap.internal.util.FormattingMessager;
import org.mapstruct.ap.internal.util.Services;
import org.mapstruct.ap.spi.EnumNamingStrategy;
import org.mapstruct.ap.spi.EnumMappingStrategy;
import org.mapstruct.ap.spi.EnumTransformationStrategy;
import org.mapstruct.ap.spi.MappingExclusionProvider;
@ -107,7 +107,7 @@ public class MappingBuilderContext {
private final Types typeUtils;
private final FormattingMessager messager;
private final AccessorNamingUtils accessorNaming;
private final EnumNamingStrategy enumNamingStrategy;
private final EnumMappingStrategy enumMappingStrategy;
private final Map<String, EnumTransformationStrategy> enumTransformationStrategies;
private final Options options;
private final TypeElement mapperTypeElement;
@ -124,7 +124,7 @@ public class MappingBuilderContext {
Types typeUtils,
FormattingMessager messager,
AccessorNamingUtils accessorNaming,
EnumNamingStrategy enumNamingStrategy,
EnumMappingStrategy enumMappingStrategy,
Map<String, EnumTransformationStrategy> enumTransformationStrategies,
Options options,
MappingResolver mappingResolver,
@ -136,7 +136,7 @@ public class MappingBuilderContext {
this.typeUtils = typeUtils;
this.messager = messager;
this.accessorNaming = accessorNaming;
this.enumNamingStrategy = enumNamingStrategy;
this.enumMappingStrategy = enumMappingStrategy;
this.enumTransformationStrategies = enumTransformationStrategies;
this.options = options;
this.mappingResolver = mappingResolver;
@ -191,8 +191,8 @@ public class MappingBuilderContext {
return accessorNaming;
}
public EnumNamingStrategy getEnumNamingStrategy() {
return enumNamingStrategy;
public EnumMappingStrategy getEnumMappingStrategy() {
return enumMappingStrategy;
}
public Map<String, EnumTransformationStrategy> getEnumTransformationStrategies() {

48
processor/src/main/java/org/mapstruct/ap/internal/model/ValueMappingMethod.java
View File

@ -43,7 +43,9 @@ public class ValueMappingMethod extends MappingMethod {
private final List<MappingEntry> valueMappings;
private final String defaultTarget;
private final String nullTarget;
private final boolean throwIllegalArgumentException;
private final Type unexpectedValueMappingException;
private final boolean overridden;
public static class Builder {
@ -90,7 +92,7 @@ public class ValueMappingMethod extends MappingMethod {
if ( targetType.isEnumType() && valueMappings.nullTarget == null ) {
// If null target is not set it means that the user has not explicitly defined a mapping for null
valueMappings.nullValueTarget = ctx.getEnumNamingStrategy()
valueMappings.nullValueTarget = ctx.getEnumMappingStrategy()
.getDefaultNullEnumConstant( targetType.getTypeElement() );
}
@ -118,14 +120,14 @@ public class ValueMappingMethod extends MappingMethod {
mappingEntries,
valueMappings.nullValueTarget,
valueMappings.defaultTargetValue,
!valueMappings.hasDefaultValue,
determineUnexpectedValueMappingException(),
beforeMappingMethods,
afterMappingMethods
);
}
private void initializeEnumTransformationStrategy() {
if ( !enumMapping.hasAnnotation() ) {
if ( !enumMapping.hasNameTransformationStrategy() ) {
enumTransformationInvoker = EnumTransformationStrategyInvoker.DEFAULT;
}
else {
@ -290,7 +292,7 @@ public class ValueMappingMethod extends MappingMethod {
}
private String getEnumConstant(TypeElement typeElement, String enumConstant) {
return ctx.getEnumNamingStrategy().getEnumConstant( typeElement, enumConstant );
return ctx.getEnumMappingStrategy().getEnumConstant( typeElement, enumConstant );
}
private SelectionParameters getSelectionParameters(Method method, Types typeUtils) {
@ -408,12 +410,26 @@ public class ValueMappingMethod extends MappingMethod {
Message.VALUEMAPPING_NON_EXISTING_CONSTANT_FROM_SPI,
valueMappings.nullValueTarget,
method.getReturnType(),
ctx.getEnumNamingStrategy()
ctx.getEnumMappingStrategy()
);
}
return !foundIncorrectMapping;
}
private Type determineUnexpectedValueMappingException() {
if ( !valueMappings.hasDefaultValue ) {
TypeMirror unexpectedValueMappingException = enumMapping.getUnexpectedValueMappingException();
if ( unexpectedValueMappingException != null ) {
return ctx.getTypeFactory().getType( unexpectedValueMappingException );
}
return ctx.getTypeFactory()
.getType( ctx.getEnumMappingStrategy().getUnexpectedValueMappingExceptionType() );
}
return null;
}
}
private static class EnumTransformationStrategyInvoker {
@ -485,16 +501,28 @@ public class ValueMappingMethod extends MappingMethod {
}
private ValueMappingMethod(Method method, List<MappingEntry> enumMappings, String nullTarget, String defaultTarget,
boolean throwIllegalArgumentException, List<LifecycleCallbackMethodReference> beforeMappingMethods,
Type unexpectedValueMappingException,
List<LifecycleCallbackMethodReference> beforeMappingMethods,
List<LifecycleCallbackMethodReference> afterMappingMethods) {
super( method, beforeMappingMethods, afterMappingMethods );
this.valueMappings = enumMappings;
this.nullTarget = nullTarget;
this.defaultTarget = defaultTarget;
this.throwIllegalArgumentException = throwIllegalArgumentException;
this.unexpectedValueMappingException = unexpectedValueMappingException;
this.overridden = method.overridesMethod();
}
@Override
public Set<Type> getImportTypes() {
Set<Type> importTypes = super.getImportTypes();
if ( unexpectedValueMappingException != null && !unexpectedValueMappingException.isJavaLangType() ) {
importTypes.addAll( unexpectedValueMappingException.getImportTypes() );
}
return importTypes;
}
public List<MappingEntry> getValueMappings() {
return valueMappings;
}
@ -507,8 +535,8 @@ public class ValueMappingMethod extends MappingMethod {
return nullTarget;
}
public boolean isThrowIllegalArgumentException() {
return throwIllegalArgumentException;
public Type getUnexpectedValueMappingException() {
return unexpectedValueMappingException;
}
public Parameter getSourceParameter() {

6
processor/src/main/java/org/mapstruct/ap/internal/model/source/DefaultOptions.java
View File

@ -8,6 +8,7 @@ package org.mapstruct.ap.internal.model.source;
import java.util.Collections;
import java.util.Set;
import javax.lang.model.type.DeclaredType;
import javax.lang.model.type.TypeMirror;
import javax.lang.model.util.Elements;
import org.mapstruct.ap.internal.option.Options;
@ -127,6 +128,11 @@ public class DefaultOptions extends DelegatingOptions {
return MappingControl.fromTypeMirror( mapper.mappingControl().getDefaultValue(), elementUtils );
}
@Override
public TypeMirror getUnexpectedValueMappingException() {
return null;
}
@Override
public boolean hasAnnotation() {
return false;

4
processor/src/main/java/org/mapstruct/ap/internal/model/source/DelegatingOptions.java
View File

@ -105,6 +105,10 @@ public abstract class DelegatingOptions {
return next.getMappingControl( elementUtils );
}
public TypeMirror getUnexpectedValueMappingException() {
return next.getUnexpectedValueMappingException();
}
DelegatingOptions next() {
return next;
}

64
processor/src/main/java/org/mapstruct/ap/internal/model/source/EnumMappingOptions.java
View File

@ -7,6 +7,7 @@ package org.mapstruct.ap.internal.model.source;
import java.util.Map;
import javax.lang.model.element.ExecutableElement;
import javax.lang.model.type.TypeMirror;
import org.mapstruct.ap.internal.gem.EnumMappingGem;
import org.mapstruct.ap.internal.util.FormattingMessager;
@ -14,6 +15,8 @@ import org.mapstruct.ap.internal.util.Strings;
import org.mapstruct.ap.spi.EnumTransformationStrategy;
import static org.mapstruct.ap.internal.util.Message.ENUMMAPPING_INCORRECT_TRANSFORMATION_STRATEGY;
import static org.mapstruct.ap.internal.util.Message.ENUMMAPPING_MISSING_CONFIGURATION;
import static org.mapstruct.ap.internal.util.Message.ENUMMAPPING_NO_ELEMENTS;
/**
* @author Filip Hrisafov
@ -40,12 +43,25 @@ public class EnumMappingOptions extends DelegatingOptions {
return valid;
}
public boolean hasNameTransformationStrategy() {
return hasAnnotation() && Strings.isNotEmpty( getNameTransformationStrategy() );
}
public String getNameTransformationStrategy() {
return enumMapping.nameTransformationStrategy().get();
return enumMapping.nameTransformationStrategy().getValue();
}
public String getNameTransformationConfiguration() {
return enumMapping.configuration().get();
return enumMapping.configuration().getValue();
}
@Override
public TypeMirror getUnexpectedValueMappingException() {
if ( enumMapping != null && enumMapping.unexpectedValueMappingException().hasValue() ) {
return enumMapping.unexpectedValueMappingException().getValue();
}
return next().getUnexpectedValueMappingException();
}
public boolean isInverse() {
@ -79,21 +95,47 @@ public class EnumMappingOptions extends DelegatingOptions {
Map<String, EnumTransformationStrategy> enumTransformationStrategies, FormattingMessager messager) {
String strategy = gem.nameTransformationStrategy().getValue();
String configuration = gem.configuration().getValue();
if ( !enumTransformationStrategies.containsKey( strategy ) ) {
String registeredStrategies = Strings.join( enumTransformationStrategies.keySet(), ", " );
boolean isConsistent = false;
if ( Strings.isNotEmpty( strategy ) || Strings.isNotEmpty( configuration ) ) {
if ( !enumTransformationStrategies.containsKey( strategy ) ) {
String registeredStrategies = Strings.join( enumTransformationStrategies.keySet(), ", " );
messager.printMessage(
method,
gem.mirror(),
gem.nameTransformationStrategy().getAnnotationValue(),
ENUMMAPPING_INCORRECT_TRANSFORMATION_STRATEGY,
strategy,
registeredStrategies
);
return false;
}
else if ( Strings.isEmpty( configuration ) ) {
messager.printMessage(
method,
gem.mirror(),
gem.configuration().getAnnotationValue(),
ENUMMAPPING_MISSING_CONFIGURATION
);
return false;
}
isConsistent = true;
}
isConsistent = isConsistent || gem.unexpectedValueMappingException().hasValue();
if ( !isConsistent ) {
messager.printMessage(
method,
gem.mirror(),
gem.nameTransformationStrategy().getAnnotationValue(),
ENUMMAPPING_INCORRECT_TRANSFORMATION_STRATEGY,
strategy,
registeredStrategies
ENUMMAPPING_NO_ELEMENTS
);
return false;
}
return true;
return isConsistent;
}
}

8
processor/src/main/java/org/mapstruct/ap/internal/model/source/MapperConfigOptions.java
View File

@ -7,6 +7,7 @@ package org.mapstruct.ap.internal.model.source;
import java.util.Set;
import javax.lang.model.type.DeclaredType;
import javax.lang.model.type.TypeMirror;
import javax.lang.model.util.Elements;
import org.mapstruct.ap.internal.gem.BuilderGem;
@ -137,6 +138,13 @@ public class MapperConfigOptions extends DelegatingOptions {
next().getMappingControl( elementUtils );
}
@Override
public TypeMirror getUnexpectedValueMappingException() {
return mapperConfig.unexpectedValueMappingException().hasValue() ?
mapperConfig.unexpectedValueMappingException().get() :
next().getUnexpectedValueMappingException();
}
@Override
public boolean hasAnnotation() {
return mapperConfig != null;

8
processor/src/main/java/org/mapstruct/ap/internal/model/source/MapperOptions.java
View File

@ -11,6 +11,7 @@ import javax.lang.model.element.Element;
import javax.lang.model.element.TypeElement;
import javax.lang.model.type.DeclaredType;
import javax.lang.model.type.TypeKind;
import javax.lang.model.type.TypeMirror;
import javax.lang.model.util.Elements;
import org.mapstruct.ap.internal.option.Options;
@ -167,6 +168,13 @@ public class MapperOptions extends DelegatingOptions {
next().getMappingControl( elementUtils );
}
@Override
public TypeMirror getUnexpectedValueMappingException() {
return mapper.unexpectedValueMappingException().hasValue() ?
mapper.unexpectedValueMappingException().get() :
next().getUnexpectedValueMappingException();
}
// @Mapper specific
public DeclaredType mapperConfigType() {

6
processor/src/main/java/org/mapstruct/ap/internal/processor/DefaultModelElementProcessorContext.java
View File

@ -26,7 +26,7 @@ import org.mapstruct.ap.internal.util.Message;
import org.mapstruct.ap.internal.util.RoundContext;
import org.mapstruct.ap.internal.util.workarounds.TypesDecorator;
import org.mapstruct.ap.internal.version.VersionInformation;
import org.mapstruct.ap.spi.EnumNamingStrategy;
import org.mapstruct.ap.spi.EnumMappingStrategy;
import org.mapstruct.ap.spi.EnumTransformationStrategy;
/**
@ -101,8 +101,8 @@ public class DefaultModelElementProcessorContext implements ProcessorContext {
}
@Override
public EnumNamingStrategy getEnumNamingStrategy() {
return roundContext.getAnnotationProcessorContext().getEnumNamingStrategy();
public EnumMappingStrategy getEnumMappingStrategy() {
return roundContext.getAnnotationProcessorContext().getEnumMappingStrategy();
}
@Override

2
processor/src/main/java/org/mapstruct/ap/internal/processor/MapperCreationProcessor.java
View File

@ -101,7 +101,7 @@ public class MapperCreationProcessor implements ModelElementProcessor<List<Sourc
typeUtils,
messager,
accessorNaming,
context.getEnumNamingStrategy(),
context.getEnumMappingStrategy(),
context.getEnumTransformationStrategies(),
options,
new MappingResolverImpl(

4
processor/src/main/java/org/mapstruct/ap/internal/processor/ModelElementProcessor.java
View File

@ -17,7 +17,7 @@ import org.mapstruct.ap.internal.option.Options;
import org.mapstruct.ap.internal.util.AccessorNamingUtils;
import org.mapstruct.ap.internal.util.FormattingMessager;
import org.mapstruct.ap.internal.version.VersionInformation;
import org.mapstruct.ap.spi.EnumNamingStrategy;
import org.mapstruct.ap.spi.EnumMappingStrategy;
import org.mapstruct.ap.spi.EnumTransformationStrategy;
/**
@ -56,7 +56,7 @@ public interface ModelElementProcessor<P, R> {
Map<String, EnumTransformationStrategy> getEnumTransformationStrategies();
EnumNamingStrategy getEnumNamingStrategy();
EnumMappingStrategy getEnumMappingStrategy();
Options getOptions();

16
processor/src/main/java/org/mapstruct/ap/internal/util/AnnotationProcessorContext.java
View File

@ -24,8 +24,8 @@ import org.mapstruct.ap.spi.AstModifyingAnnotationProcessor;
import org.mapstruct.ap.spi.BuilderProvider;
import org.mapstruct.ap.spi.DefaultAccessorNamingStrategy;
import org.mapstruct.ap.spi.DefaultBuilderProvider;
import org.mapstruct.ap.spi.DefaultEnumNamingStrategy;
import org.mapstruct.ap.spi.EnumNamingStrategy;
import org.mapstruct.ap.spi.DefaultEnumMappingStrategy;
import org.mapstruct.ap.spi.EnumMappingStrategy;
import org.mapstruct.ap.spi.EnumTransformationStrategy;
import org.mapstruct.ap.spi.FreeBuilderAccessorNamingStrategy;
import org.mapstruct.ap.spi.ImmutablesAccessorNamingStrategy;
@ -43,7 +43,7 @@ public class AnnotationProcessorContext implements MapStructProcessingEnvironmen
private BuilderProvider builderProvider;
private AccessorNamingStrategy accessorNamingStrategy;
private EnumNamingStrategy enumNamingStrategy;
private EnumMappingStrategy enumMappingStrategy;
private boolean initialized;
private Map<String, EnumTransformationStrategy> enumTransformationStrategies;
@ -113,13 +113,13 @@ public class AnnotationProcessorContext implements MapStructProcessingEnvironmen
}
this.accessorNaming = new AccessorNamingUtils( this.accessorNamingStrategy );
this.enumNamingStrategy = Services.get( EnumNamingStrategy.class, new DefaultEnumNamingStrategy() );
this.enumNamingStrategy.init( this );
this.enumMappingStrategy = Services.get( EnumMappingStrategy.class, new DefaultEnumMappingStrategy() );
this.enumMappingStrategy.init( this );
if ( verbose ) {
messager.printMessage(
Diagnostic.Kind.NOTE,
"MapStruct: Using enum naming strategy: "
+ this.enumNamingStrategy.getClass().getCanonicalName()
+ this.enumMappingStrategy.getClass().getCanonicalName()
);
}
@ -250,9 +250,9 @@ public class AnnotationProcessorContext implements MapStructProcessingEnvironmen
return accessorNamingStrategy;
}
public EnumNamingStrategy getEnumNamingStrategy() {
public EnumMappingStrategy getEnumMappingStrategy() {
initialize();
return enumNamingStrategy;
return enumMappingStrategy;
}
public BuilderProvider getBuilderProvider() {

4
processor/src/main/java/org/mapstruct/ap/internal/util/Message.java
View File

@ -105,6 +105,8 @@ public enum Message {
ENUMMAPPING_UNMAPPED_SOURCES( "The following constants from the source enum have no corresponding constant in the target enum and must be be mapped via adding additional mappings: %s." ),
ENUMMAPPING_REMOVED( "Mapping of Enums via @Mapping is removed. Please use @ValueMapping instead!" ),
ENUMMAPPING_INCORRECT_TRANSFORMATION_STRATEGY( "There is no registered EnumTransformationStrategy for '%s'. Registered strategies are: %s." ),
ENUMMAPPING_MISSING_CONFIGURATION( "Configuration has to be defined when strategy is defined." ),
ENUMMAPPING_NO_ELEMENTS( "'nameTransformationStrategy', 'configuration' and 'unexpectedValueMappingException' are undefined in @EnumMapping, define at least one of them." ),
LIFECYCLEMETHOD_AMBIGUOUS_PARAMETERS( "Lifecycle method has multiple matching parameters (e. g. same type), in this case please ensure to name the parameters in the lifecycle and mapping method identical. This lifecycle method will not be used for the mapping method '%s'.", Diagnostic.Kind.WARNING),
@ -169,7 +171,7 @@ public enum Message {
VALUEMAPPING_UNMAPPED_SOURCES( "The following constants from the %s enum have no corresponding constant in the %s enum and must be be mapped via adding additional mappings: %s." ),
VALUEMAPPING_ANY_REMAINING_FOR_NON_ENUM( "Source = \"<ANY_REMAINING>\" can only be used on targets of type enum and not for %s." ),
VALUEMAPPING_ANY_REMAINING_OR_UNMAPPED_MISSING( "Source = \"<ANY_REMAINING>\" or \"<ANY_UNMAPPED>\" is advisable for mapping of type String to an enum type.", Diagnostic.Kind.WARNING ),
VALUEMAPPING_NON_EXISTING_CONSTANT_FROM_SPI( "Constant %s doesn't exist in enum type %s. Constant was returned from EnumNamingStrategy: %s"),
VALUEMAPPING_NON_EXISTING_CONSTANT_FROM_SPI( "Constant %s doesn't exist in enum type %s. Constant was returned from EnumMappingStrategy: %s"),
VALUEMAPPING_NON_EXISTING_CONSTANT( "Constant %s doesn't exist in enum type %s." );
// CHECKSTYLE:ON

4
processor/src/main/java/org/mapstruct/ap/internal/util/Strings.java
View File

@ -129,6 +129,10 @@ public class Strings {
return string == null || string.isEmpty();
}
public static boolean isNotEmpty(String string) {
return !isEmpty( string );
}
public static String getSafeVariableName(String name, String... existingVariableNames) {
return getSafeVariableName( name, Arrays.asList( existingVariableNames ) );
}

11
processor/src/main/java/org/mapstruct/ap/spi/DefaultEnumNamingStrategy.java → processor/src/main/java/org/mapstruct/ap/spi/DefaultEnumMappingStrategy.java
View File

@ -14,7 +14,7 @@ import javax.lang.model.util.Types;
*
* @since 1.4
*/
public class DefaultEnumNamingStrategy implements EnumNamingStrategy {
public class DefaultEnumMappingStrategy implements EnumMappingStrategy {
protected Elements elementUtils;
protected Types typeUtils;
@ -34,4 +34,13 @@ public class DefaultEnumNamingStrategy implements EnumNamingStrategy {
public String getEnumConstant(TypeElement enumType, String enumConstant) {
return enumConstant;
}
@Override
public TypeElement getUnexpectedValueMappingExceptionType() {
return elementUtils.getTypeElement( getUnexpectedValueMappingExceptionClass().getCanonicalName() );
}
protected Class<? extends Exception> getUnexpectedValueMappingExceptionClass() {
return IllegalArgumentException.class;
}
}

11
processor/src/main/java/org/mapstruct/ap/spi/EnumNamingStrategy.java → processor/src/main/java/org/mapstruct/ap/spi/EnumMappingStrategy.java
View File

@ -13,11 +13,12 @@ import org.mapstruct.util.Experimental;
* A service provider interface for the mapping between different enum constants
*
* @author Arne Seime
* @author Filip Hrisafov
*
* @since 1.4
*/
@Experimental("This SPI can have it's signature changed in subsequent releases")
public interface EnumNamingStrategy {
public interface EnumMappingStrategy {
/**
* Initializes the enum value mapping strategy
@ -47,4 +48,12 @@ public interface EnumNamingStrategy {
* never return null
*/
String getEnumConstant(TypeElement enumType, String enumConstant);
/**
* Return the type element of the exception that should be used in the generated code
* for an unexpected enum constant.
*
* @return the type element of the exception that should be used, never {@code null}
*/
TypeElement getUnexpectedValueMappingExceptionType();
}

4
processor/src/main/resources/org/mapstruct/ap/internal/model/ValueMappingMethod.ftl
View File

@ -25,7 +25,7 @@
case <@writeSource source=valueMapping.source/>: ${resultName} = <@writeTarget target=valueMapping.target/>;
break;
</#list>
default: <#if throwIllegalArgumentException>throw new IllegalArgumentException( "Unexpected enum constant: " + ${sourceParameter.name} )<#else>${resultName} = <@writeTarget target=defaultTarget/></#if>;
default: <#if unexpectedValueMappingException??>throw new <@includeModel object=unexpectedValueMappingException />( "Unexpected enum constant: " + ${sourceParameter.name} )<#else>${resultName} = <@writeTarget target=defaultTarget/></#if>;
}
<#list beforeMappingReferencesWithMappingTarget as callback>
<#if callback_index = 0>
@ -40,7 +40,7 @@
<@includeModel object=callback targetBeanName=resultName targetType=resultType/>
</#list>
<#if !(valueMappings.empty && throwIllegalArgumentException)>
<#if !(valueMappings.empty && unexpectedValueMappingException??)>
return ${resultName};
</#if>
}

16
processor/src/test/java/org/mapstruct/ap/test/value/CustomIllegalArgumentException.java Normal file
View File

@ -0,0 +1,16 @@
/*
* Copyright MapStruct Authors.
*
* Licensed under the Apache License version 2.0, available at http://www.apache.org/licenses/LICENSE-2.0
*/
package org.mapstruct.ap.test.value;
/**
* @author Filip Hrisafov
*/
public class CustomIllegalArgumentException extends RuntimeException {
public CustomIllegalArgumentException(String message) {
super( message );
}
}

25
processor/src/test/java/org/mapstruct/ap/test/value/erroneous/EmptyEnumMappingMapper.java Normal file
View File

@ -0,0 +1,25 @@
/*
* Copyright MapStruct Authors.
*
* Licensed under the Apache License version 2.0, available at http://www.apache.org/licenses/LICENSE-2.0
*/
package org.mapstruct.ap.test.value.erroneous;
import org.mapstruct.EnumMapping;
import org.mapstruct.Mapper;
import org.mapstruct.ValueMapping;
import org.mapstruct.ap.test.value.ExternalOrderType;
import org.mapstruct.ap.test.value.OrderType;
/**
* @author Filip Hrisafov
*/
@Mapper
public interface EmptyEnumMappingMapper {
@EnumMapping
@ValueMapping(source = "EXTRA", target = "SPECIAL")
@ValueMapping(source = "STANDARD", target = "DEFAULT")
@ValueMapping(source = "NORMAL", target = "DEFAULT")
ExternalOrderType onlyWithMappings(OrderType orderType);
}

63
processor/src/test/java/org/mapstruct/ap/test/value/erroneous/ErroneousEnumMappingTest.java Normal file
View File

@ -0,0 +1,63 @@
/*
* Copyright MapStruct Authors.
*
* Licensed under the Apache License version 2.0, available at http://www.apache.org/licenses/LICENSE-2.0
*/
package org.mapstruct.ap.test.value.erroneous;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.mapstruct.ap.test.value.CustomIllegalArgumentException;
import org.mapstruct.ap.test.value.ExternalOrderType;
import org.mapstruct.ap.test.value.OrderType;
import org.mapstruct.ap.testutil.IssueKey;
import org.mapstruct.ap.testutil.WithClasses;
import org.mapstruct.ap.testutil.compilation.annotation.CompilationResult;
import org.mapstruct.ap.testutil.compilation.annotation.Diagnostic;
import org.mapstruct.ap.testutil.compilation.annotation.ExpectedCompilationOutcome;
import org.mapstruct.ap.testutil.runner.AnnotationProcessorTestRunner;
/**
* @author Filip Hrisafov
*/
@IssueKey("2169")
@RunWith(AnnotationProcessorTestRunner.class)
@WithClasses({
CustomIllegalArgumentException.class,
ExternalOrderType.class,
OrderType.class,
})
public class ErroneousEnumMappingTest {
@Test
@WithClasses({
EmptyEnumMappingMapper.class
})
@ExpectedCompilationOutcome(value = CompilationResult.FAILED,
diagnostics = {
@Diagnostic(type = EmptyEnumMappingMapper.class,
kind = javax.tools.Diagnostic.Kind.ERROR,
line = 20,
message = "'nameTransformationStrategy', 'configuration' and 'unexpectedValueMappingException' are " +
"undefined in @EnumMapping, define at least one of them."
)
}
)
public void shouldCompileErrorWhenEnumMappingIsEmpty() {
}
@Test
@WithClasses({
NoConfigurationEnumMappingMapper.class
})
@ExpectedCompilationOutcome(value = CompilationResult.FAILED,
diagnostics = {
@Diagnostic(type = NoConfigurationEnumMappingMapper.class,
kind = javax.tools.Diagnostic.Kind.ERROR,
line = 21,
message = "Configuration has to be defined when strategy is defined.")
}
)
public void shouldCompileErrorWhenEnumMappingHasStrategyButNoConfiguration() {
}
}

26
processor/src/test/java/org/mapstruct/ap/test/value/erroneous/NoConfigurationEnumMappingMapper.java Normal file
View File

@ -0,0 +1,26 @@
/*
* Copyright MapStruct Authors.
*
* Licensed under the Apache License version 2.0, available at http://www.apache.org/licenses/LICENSE-2.0
*/
package org.mapstruct.ap.test.value.erroneous;
import org.mapstruct.EnumMapping;
import org.mapstruct.Mapper;
import org.mapstruct.MappingConstants;
import org.mapstruct.ValueMapping;
import org.mapstruct.ap.test.value.ExternalOrderType;
import org.mapstruct.ap.test.value.OrderType;
/**
* @author Filip Hrisafov
*/
@Mapper
public interface NoConfigurationEnumMappingMapper {
@EnumMapping(nameTransformationStrategy = MappingConstants.PREFIX_TRANSFORMATION)
@ValueMapping(source = "EXTRA", target = "SPECIAL")
@ValueMapping(source = "STANDARD", target = "DEFAULT")
@ValueMapping(source = "NORMAL", target = "DEFAULT")
ExternalOrderType onlyWithMappings(OrderType orderType);
}

16
processor/src/test/java/org/mapstruct/ap/test/value/exception/Config.java Normal file
View File

@ -0,0 +1,16 @@
/*
* Copyright MapStruct Authors.
*
* Licensed under the Apache License version 2.0, available at http://www.apache.org/licenses/LICENSE-2.0
*/
package org.mapstruct.ap.test.value.exception;
import org.mapstruct.MapperConfig;
import org.mapstruct.ap.test.value.CustomIllegalArgumentException;
/**
* @author Filip Hrisafov
*/
@MapperConfig(unexpectedValueMappingException = CustomIllegalArgumentException.class)
public interface Config {
}

35
processor/src/test/java/org/mapstruct/ap/test/value/exception/CustomUnexpectedValueMappingExceptionDefinedInMapper.java Normal file
View File

@ -0,0 +1,35 @@
/*
* Copyright MapStruct Authors.
*
* Licensed under the Apache License version 2.0, available at http://www.apache.org/licenses/LICENSE-2.0
*/
package org.mapstruct.ap.test.value.exception;
import org.mapstruct.InheritInverseConfiguration;
import org.mapstruct.Mapper;
import org.mapstruct.MappingConstants;
import org.mapstruct.ValueMapping;
import org.mapstruct.ap.test.value.CustomIllegalArgumentException;
import org.mapstruct.ap.test.value.ExternalOrderType;
import org.mapstruct.ap.test.value.OrderType;
/**
* @author Filip Hrisafov
*/
@Mapper(unexpectedValueMappingException = CustomIllegalArgumentException.class)
public interface CustomUnexpectedValueMappingExceptionDefinedInMapper {
@ValueMapping(source = MappingConstants.ANY_UNMAPPED, target = "DEFAULT")
ExternalOrderType withAnyUnmapped(OrderType orderType);
@ValueMapping(source = MappingConstants.ANY_REMAINING, target = "DEFAULT")
ExternalOrderType withAnyRemaining(OrderType orderType);
@ValueMapping(source = "EXTRA", target = "SPECIAL")
@ValueMapping(source = "STANDARD", target = "DEFAULT")
@ValueMapping(source = "NORMAL", target = "DEFAULT")
ExternalOrderType onlyWithMappings(OrderType orderType);
@InheritInverseConfiguration(name = "onlyWithMappings")
OrderType inverseOnlyWithMappings(ExternalOrderType orderType);
}

38
processor/src/test/java/org/mapstruct/ap/test/value/exception/CustomUnexpectedValueMappingExceptionDefinedInMapperAndEnumMapping.java Normal file
View File

@ -0,0 +1,38 @@
/*
* Copyright MapStruct Authors.
*
* Licensed under the Apache License version 2.0, available at http://www.apache.org/licenses/LICENSE-2.0
*/
package org.mapstruct.ap.test.value.exception;
import org.mapstruct.EnumMapping;
import org.mapstruct.InheritInverseConfiguration;
import org.mapstruct.Mapper;
import org.mapstruct.MappingConstants;
import org.mapstruct.ValueMapping;
import org.mapstruct.ap.test.value.CustomIllegalArgumentException;
import org.mapstruct.ap.test.value.ExternalOrderType;
import org.mapstruct.ap.test.value.OrderType;
/**
* @author Filip Hrisafov
*/
@Mapper(unexpectedValueMappingException = CustomIllegalArgumentException.class)
public interface CustomUnexpectedValueMappingExceptionDefinedInMapperAndEnumMapping {
@ValueMapping(source = MappingConstants.ANY_UNMAPPED, target = "DEFAULT")
ExternalOrderType withAnyUnmapped(OrderType orderType);
@ValueMapping(source = MappingConstants.ANY_REMAINING, target = "DEFAULT")
ExternalOrderType withAnyRemaining(OrderType orderType);
@ValueMapping(source = "EXTRA", target = "SPECIAL")
@ValueMapping(source = "STANDARD", target = "DEFAULT")
@ValueMapping(source = "NORMAL", target = "DEFAULT")
ExternalOrderType onlyWithMappings(OrderType orderType);
// If unexpectedValueMappingException is explicitly defined then it should be used instead of what is in the SPI
@EnumMapping(unexpectedValueMappingException = IllegalArgumentException.class)
@InheritInverseConfiguration(name = "onlyWithMappings")
OrderType inverseOnlyWithMappings(ExternalOrderType orderType);
}

34
processor/src/test/java/org/mapstruct/ap/test/value/exception/CustomUnexpectedValueMappingExceptionDefinedInMapperConfig.java Normal file
View File

@ -0,0 +1,34 @@
/*
* Copyright MapStruct Authors.
*
* Licensed under the Apache License version 2.0, available at http://www.apache.org/licenses/LICENSE-2.0
*/
package org.mapstruct.ap.test.value.exception;
import org.mapstruct.InheritInverseConfiguration;
import org.mapstruct.Mapper;
import org.mapstruct.MappingConstants;
import org.mapstruct.ValueMapping;
import org.mapstruct.ap.test.value.ExternalOrderType;
import org.mapstruct.ap.test.value.OrderType;
/**
* @author Filip Hrisafov
*/
@Mapper(config = Config.class)
public interface CustomUnexpectedValueMappingExceptionDefinedInMapperConfig {
@ValueMapping(source = MappingConstants.ANY_UNMAPPED, target = "DEFAULT")
ExternalOrderType withAnyUnmapped(OrderType orderType);
@ValueMapping(source = MappingConstants.ANY_REMAINING, target = "DEFAULT")
ExternalOrderType withAnyRemaining(OrderType orderType);
@ValueMapping(source = "EXTRA", target = "SPECIAL")
@ValueMapping(source = "STANDARD", target = "DEFAULT")
@ValueMapping(source = "NORMAL", target = "DEFAULT")
ExternalOrderType onlyWithMappings(OrderType orderType);
@InheritInverseConfiguration(name = "onlyWithMappings")
OrderType inverseOnlyWithMappings(ExternalOrderType orderType);
}

39
processor/src/test/java/org/mapstruct/ap/test/value/exception/CustomUnexpectedValueMappingExceptionMapper.java Normal file
View File

@ -0,0 +1,39 @@
/*
* Copyright MapStruct Authors.
*
* Licensed under the Apache License version 2.0, available at http://www.apache.org/licenses/LICENSE-2.0
*/
package org.mapstruct.ap.test.value.exception;
import org.mapstruct.EnumMapping;
import org.mapstruct.InheritInverseConfiguration;
import org.mapstruct.Mapper;
import org.mapstruct.MappingConstants;
import org.mapstruct.ValueMapping;
import org.mapstruct.ap.test.value.CustomIllegalArgumentException;
import org.mapstruct.ap.test.value.ExternalOrderType;
import org.mapstruct.ap.test.value.OrderType;
/**
* @author Filip Hrisafov
*/
@Mapper
public interface CustomUnexpectedValueMappingExceptionMapper {
@EnumMapping(unexpectedValueMappingException = CustomIllegalArgumentException.class)
@ValueMapping( source = MappingConstants.ANY_UNMAPPED, target = "DEFAULT" )
ExternalOrderType withAnyUnmapped(OrderType orderType);
@EnumMapping(unexpectedValueMappingException = CustomIllegalArgumentException.class)
@ValueMapping( source = MappingConstants.ANY_REMAINING, target = "DEFAULT" )
ExternalOrderType withAnyRemaining(OrderType orderType);
@EnumMapping(unexpectedValueMappingException = CustomIllegalArgumentException.class)
@ValueMapping(source = "EXTRA", target = "SPECIAL")
@ValueMapping(source = "STANDARD", target = "DEFAULT")
@ValueMapping(source = "NORMAL", target = "DEFAULT")
ExternalOrderType onlyWithMappings(OrderType orderType);
@InheritInverseConfiguration(name = "onlyWithMappings")
OrderType inverseOnlyWithMappings(ExternalOrderType orderType);
}

48
processor/src/test/java/org/mapstruct/ap/test/value/exception/CustomUnexpectedValueMappingExceptionTest.java Normal file
View File

@ -0,0 +1,48 @@
/*
* Copyright MapStruct Authors.
*
* Licensed under the Apache License version 2.0, available at http://www.apache.org/licenses/LICENSE-2.0
*/
package org.mapstruct.ap.test.value.exception;
import org.junit.Rule;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.mapstruct.ap.test.value.CustomIllegalArgumentException;
import org.mapstruct.ap.test.value.ExternalOrderType;
import org.mapstruct.ap.test.value.OrderType;
import org.mapstruct.ap.testutil.IssueKey;
import org.mapstruct.ap.testutil.WithClasses;
import org.mapstruct.ap.testutil.runner.AnnotationProcessorTestRunner;
import org.mapstruct.ap.testutil.runner.GeneratedSource;
/**
* @author Filip Hrisafov
*/
@IssueKey("2169")
@RunWith(AnnotationProcessorTestRunner.class)
@WithClasses({
Config.class,
CustomUnexpectedValueMappingExceptionDefinedInMapper.class,
CustomUnexpectedValueMappingExceptionDefinedInMapperAndEnumMapping.class,
CustomUnexpectedValueMappingExceptionDefinedInMapperConfig.class,
CustomUnexpectedValueMappingExceptionMapper.class,
CustomIllegalArgumentException.class,
ExternalOrderType.class,
OrderType.class
})
public class CustomUnexpectedValueMappingExceptionTest {
@Rule
public final GeneratedSource generatedSource = new GeneratedSource();
@Test
public void shouldGenerateCustomUnexpectedValueMappingException() {
generatedSource.addComparisonToFixtureFor(
CustomUnexpectedValueMappingExceptionDefinedInMapper.class,
CustomUnexpectedValueMappingExceptionDefinedInMapperAndEnumMapping.class,
CustomUnexpectedValueMappingExceptionDefinedInMapperConfig.class,
CustomUnexpectedValueMappingExceptionMapper.class
);
}
}

3
processor/src/test/java/org/mapstruct/ap/test/value/spi/CustomCheeseMapper.java
View File

@ -5,6 +5,7 @@
*/
package org.mapstruct.ap.test.value.spi;
import org.mapstruct.EnumMapping;
import org.mapstruct.Mapper;
import org.mapstruct.MappingConstants;
import org.mapstruct.ValueMapping;
@ -24,6 +25,8 @@ public interface CustomCheeseMapper {
String mapToString(CustomCheeseType cheeseType);
// If unexpectedValueMappingException is explicitly defined then it should be used instead of what is in the SPI
@EnumMapping(unexpectedValueMappingException = IllegalArgumentException.class)
String mapToString(CheeseType cheeseType);
@ValueMapping(source = MappingConstants.ANY_REMAINING, target = "CUSTOM_BRIE")

12
processor/src/test/java/org/mapstruct/ap/test/value/spi/CustomEnumNamingStrategy.java → processor/src/test/java/org/mapstruct/ap/test/value/spi/CustomEnumMappingStrategy.java
View File

@ -9,13 +9,14 @@ import javax.lang.model.element.TypeElement;
import javax.lang.model.type.TypeMirror;
import org.mapstruct.ap.internal.gem.MappingConstantsGem;
import org.mapstruct.ap.spi.DefaultEnumNamingStrategy;
import org.mapstruct.ap.spi.EnumNamingStrategy;
import org.mapstruct.ap.spi.DefaultEnumMappingStrategy;
import org.mapstruct.ap.spi.EnumMappingStrategy;
import org.mapstruct.ap.test.value.CustomIllegalArgumentException;
/**
* @author Filip Hrisafov
*/
public class CustomEnumNamingStrategy extends DefaultEnumNamingStrategy implements EnumNamingStrategy {
public class CustomEnumMappingStrategy extends DefaultEnumMappingStrategy implements EnumMappingStrategy {
@Override
public String getDefaultNullEnumConstant(TypeElement enumType) {
@ -51,4 +52,9 @@ public class CustomEnumNamingStrategy extends DefaultEnumNamingStrategy implemen
return false;
}
@Override
protected Class<? extends Exception> getUnexpectedValueMappingExceptionClass() {
return CustomIllegalArgumentException.class;
}
}

10
processor/src/test/java/org/mapstruct/ap/test/value/spi/CustomEnumNamingStrategyTest.java → processor/src/test/java/org/mapstruct/ap/test/value/spi/CustomEnumMappingStrategyTest.java
View File

@ -8,6 +8,7 @@ package org.mapstruct.ap.test.value.spi;
import org.junit.Rule;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.mapstruct.ap.test.value.CustomIllegalArgumentException;
import org.mapstruct.ap.testutil.WithClasses;
import org.mapstruct.ap.testutil.WithServiceImplementation;
import org.mapstruct.ap.testutil.runner.AnnotationProcessorTestRunner;
@ -23,9 +24,10 @@ import static org.assertj.core.api.Assertions.assertThat;
CheeseType.class,
CustomCheeseType.class,
CustomEnumMarker.class,
CustomIllegalArgumentException.class,
})
@WithServiceImplementation(CustomEnumNamingStrategy.class)
public class CustomEnumNamingStrategyTest {
@WithServiceImplementation(CustomEnumMappingStrategy.class)
public class CustomEnumMappingStrategyTest {
@Rule
public final GeneratedSource generatedSource = new GeneratedSource();
@ -34,7 +36,7 @@ public class CustomEnumNamingStrategyTest {
@WithClasses({
CustomCheeseMapper.class
})
public void shouldApplyCustomEnumNamingStrategy() {
public void shouldApplyCustomEnumMappingStrategy() {
generatedSource.addComparisonToFixtureFor( CustomCheeseMapper.class );
CustomCheeseMapper mapper = CustomCheeseMapper.INSTANCE;
@ -80,7 +82,7 @@ public class CustomEnumNamingStrategyTest {
@WithClasses({
OverridesCustomCheeseMapper.class
})
public void shouldApplyDefinedMappingsInsteadOfCustomEnumNamingStrategy() {
public void shouldApplyDefinedMappingsInsteadOfCustomEnumMappingStrategy() {
OverridesCustomCheeseMapper mapper = OverridesCustomCheeseMapper.INSTANCE;
// CheeseType -> CustomCheeseType

6
processor/src/test/java/org/mapstruct/ap/test/value/spi/CustomErroneousEnumNamingStrategy.java → processor/src/test/java/org/mapstruct/ap/test/value/spi/CustomErroneousEnumMappingStrategy.java
View File

@ -9,13 +9,13 @@ import javax.lang.model.element.TypeElement;
import javax.lang.model.type.TypeMirror;
import org.mapstruct.ap.internal.gem.MappingConstantsGem;
import org.mapstruct.ap.spi.DefaultEnumNamingStrategy;
import org.mapstruct.ap.spi.EnumNamingStrategy;
import org.mapstruct.ap.spi.DefaultEnumMappingStrategy;
import org.mapstruct.ap.spi.EnumMappingStrategy;
/**
* @author Filip Hrisafov
*/
public class CustomErroneousEnumNamingStrategy extends DefaultEnumNamingStrategy implements EnumNamingStrategy {
public class CustomErroneousEnumMappingStrategy extends DefaultEnumMappingStrategy implements EnumMappingStrategy {
@Override
public String getDefaultNullEnumConstant(TypeElement enumType) {

14
processor/src/test/java/org/mapstruct/ap/test/value/spi/CustomErroneousEnumNamingStrategyTest.java → processor/src/test/java/org/mapstruct/ap/test/value/spi/CustomErroneousEnumMappingStrategyTest.java
View File

@ -25,8 +25,8 @@ import static org.assertj.core.api.Assertions.assertThat;
CustomCheeseType.class,
CustomEnumMarker.class,
})
@WithServiceImplementation(CustomErroneousEnumNamingStrategy.class)
public class CustomErroneousEnumNamingStrategyTest {
@WithServiceImplementation(CustomErroneousEnumMappingStrategy.class)
public class CustomErroneousEnumMappingStrategyTest {
@Test
@WithClasses({
@ -37,18 +37,18 @@ public class CustomErroneousEnumNamingStrategyTest {
@Diagnostic(
type = CustomCheeseMapper.class,
kind = javax.tools.Diagnostic.Kind.ERROR,
line = 23,
line = 24,
messageRegExp = "Constant INCORRECT doesn't exist in enum type " +
"org\\.mapstruct\\.ap\\.test\\.value\\.spi\\.CustomCheeseType." +
" Constant was returned from EnumNamingStrategy: .*CustomErroneousEnumNamingStrategy@.*"
" Constant was returned from EnumMappingStrategy: .*CustomErroneousEnumMappingStrategy@.*"
),
@Diagnostic(
type = CustomCheeseMapper.class,
kind = javax.tools.Diagnostic.Kind.ERROR,
line = 30,
line = 33,
messageRegExp = "Constant INCORRECT doesn't exist in enum type " +
"org\\.mapstruct\\.ap\\.test\\.value\\.spi\\.CustomCheeseType." +
" Constant was returned from EnumNamingStrategy: .*CustomErroneousEnumNamingStrategy@.*"
" Constant was returned from EnumMappingStrategy: .*CustomErroneousEnumMappingStrategy@.*"
)
}
)
@ -59,7 +59,7 @@ public class CustomErroneousEnumNamingStrategyTest {
@WithClasses({
OverridesCustomCheeseMapper.class
})
public void shouldApplyDefinedMappingsInsteadOfCustomEnumNamingStrategy() {
public void shouldApplyDefinedMappingsInsteadOfCustomEnumMappingStrategy() {
OverridesCustomCheeseMapper mapper = OverridesCustomCheeseMapper.INSTANCE;
// CheeseType -> CustomCheeseType

101
processor/src/test/resources/fixtures/org/mapstruct/ap/test/value/exception/CustomUnexpectedValueMappingExceptionDefinedInMapperAndEnumMappingImpl.java Normal file
View File

@ -0,0 +1,101 @@
/*
* Copyright MapStruct Authors.
*
* Licensed under the Apache License version 2.0, available at http://www.apache.org/licenses/LICENSE-2.0
*/
package org.mapstruct.ap.test.value.exception;
import javax.annotation.Generated;
import org.mapstruct.ap.test.value.CustomIllegalArgumentException;
import org.mapstruct.ap.test.value.ExternalOrderType;
import org.mapstruct.ap.test.value.OrderType;
@Generated(
value = "org.mapstruct.ap.MappingProcessor",
date = "2020-08-29T09:36:57+0200",
comments = "version: , compiler: javac, environment: Java 11.0.2 (AdoptOpenJDK)"
)
public class CustomUnexpectedValueMappingExceptionDefinedInMapperAndEnumMappingImpl implements CustomUnexpectedValueMappingExceptionDefinedInMapperAndEnumMapping {
@Override
public ExternalOrderType withAnyUnmapped(OrderType orderType) {
if ( orderType == null ) {
return null;
}
ExternalOrderType externalOrderType;
switch ( orderType ) {
default: externalOrderType = ExternalOrderType.DEFAULT;
}
return externalOrderType;
}
@Override
public ExternalOrderType withAnyRemaining(OrderType orderType) {
if ( orderType == null ) {
return null;
}
ExternalOrderType externalOrderType;
switch ( orderType ) {
case RETAIL: externalOrderType = ExternalOrderType.RETAIL;
break;
case B2B: externalOrderType = ExternalOrderType.B2B;
break;
default: externalOrderType = ExternalOrderType.DEFAULT;
}
return externalOrderType;
}
@Override
public ExternalOrderType onlyWithMappings(OrderType orderType) {
if ( orderType == null ) {
return null;
}
ExternalOrderType externalOrderType;
switch ( orderType ) {
case EXTRA: externalOrderType = ExternalOrderType.SPECIAL;
break;
case STANDARD: externalOrderType = ExternalOrderType.DEFAULT;
break;
case NORMAL: externalOrderType = ExternalOrderType.DEFAULT;
break;
case RETAIL: externalOrderType = ExternalOrderType.RETAIL;
break;
case B2B: externalOrderType = ExternalOrderType.B2B;
break;
default: throw new CustomIllegalArgumentException( "Unexpected enum constant: " + orderType );
}
return externalOrderType;
}
@Override
public OrderType inverseOnlyWithMappings(ExternalOrderType orderType) {
if ( orderType == null ) {
return null;
}
OrderType orderType1;
switch ( orderType ) {
case SPECIAL: orderType1 = OrderType.EXTRA;
break;
case DEFAULT: orderType1 = OrderType.STANDARD;
break;
case RETAIL: orderType1 = OrderType.RETAIL;
break;
case B2B: orderType1 = OrderType.B2B;
break;
default: throw new IllegalArgumentException( "Unexpected enum constant: " + orderType );
}
return orderType1;
}
}

101
processor/src/test/resources/fixtures/org/mapstruct/ap/test/value/exception/CustomUnexpectedValueMappingExceptionDefinedInMapperConfigImpl.java Normal file
View File

@ -0,0 +1,101 @@
/*
* Copyright MapStruct Authors.
*
* Licensed under the Apache License version 2.0, available at http://www.apache.org/licenses/LICENSE-2.0
*/
package org.mapstruct.ap.test.value.exception;
import javax.annotation.Generated;
import org.mapstruct.ap.test.value.CustomIllegalArgumentException;
import org.mapstruct.ap.test.value.ExternalOrderType;
import org.mapstruct.ap.test.value.OrderType;
@Generated(
value = "org.mapstruct.ap.MappingProcessor",
date = "2020-08-29T09:36:57+0200",
comments = "version: , compiler: javac, environment: Java 11.0.2 (AdoptOpenJDK)"
)
public class CustomUnexpectedValueMappingExceptionDefinedInMapperConfigImpl implements CustomUnexpectedValueMappingExceptionDefinedInMapperConfig {
@Override
public ExternalOrderType withAnyUnmapped(OrderType orderType) {
if ( orderType == null ) {
return null;
}
ExternalOrderType externalOrderType;
switch ( orderType ) {
default: externalOrderType = ExternalOrderType.DEFAULT;
}
return externalOrderType;
}
@Override
public ExternalOrderType withAnyRemaining(OrderType orderType) {
if ( orderType == null ) {
return null;
}
ExternalOrderType externalOrderType;
switch ( orderType ) {
case RETAIL: externalOrderType = ExternalOrderType.RETAIL;
break;
case B2B: externalOrderType = ExternalOrderType.B2B;
break;
default: externalOrderType = ExternalOrderType.DEFAULT;
}
return externalOrderType;
}
@Override
public ExternalOrderType onlyWithMappings(OrderType orderType) {
if ( orderType == null ) {
return null;
}
ExternalOrderType externalOrderType;
switch ( orderType ) {
case EXTRA: externalOrderType = ExternalOrderType.SPECIAL;
break;
case STANDARD: externalOrderType = ExternalOrderType.DEFAULT;
break;
case NORMAL: externalOrderType = ExternalOrderType.DEFAULT;
break;
case RETAIL: externalOrderType = ExternalOrderType.RETAIL;
break;
case B2B: externalOrderType = ExternalOrderType.B2B;
break;
default: throw new CustomIllegalArgumentException( "Unexpected enum constant: " + orderType );
}
return externalOrderType;
}
@Override
public OrderType inverseOnlyWithMappings(ExternalOrderType orderType) {
if ( orderType == null ) {
return null;
}
OrderType orderType1;
switch ( orderType ) {
case SPECIAL: orderType1 = OrderType.EXTRA;
break;
case DEFAULT: orderType1 = OrderType.STANDARD;
break;
case RETAIL: orderType1 = OrderType.RETAIL;
break;
case B2B: orderType1 = OrderType.B2B;
break;
default: throw new CustomIllegalArgumentException( "Unexpected enum constant: " + orderType );
}
return orderType1;
}
}

101
processor/src/test/resources/fixtures/org/mapstruct/ap/test/value/exception/CustomUnexpectedValueMappingExceptionDefinedInMapperImpl.java Normal file
View File

@ -0,0 +1,101 @@
/*
* Copyright MapStruct Authors.
*
* Licensed under the Apache License version 2.0, available at http://www.apache.org/licenses/LICENSE-2.0
*/
package org.mapstruct.ap.test.value.exception;
import javax.annotation.Generated;
import org.mapstruct.ap.test.value.CustomIllegalArgumentException;
import org.mapstruct.ap.test.value.ExternalOrderType;
import org.mapstruct.ap.test.value.OrderType;
@Generated(
value = "org.mapstruct.ap.MappingProcessor",
date = "2020-08-29T09:36:57+0200",
comments = "version: , compiler: javac, environment: Java 11.0.2 (AdoptOpenJDK)"
)
public class CustomUnexpectedValueMappingExceptionDefinedInMapperImpl implements CustomUnexpectedValueMappingExceptionDefinedInMapper {
@Override
public ExternalOrderType withAnyUnmapped(OrderType orderType) {
if ( orderType == null ) {
return null;
}
ExternalOrderType externalOrderType;
switch ( orderType ) {
default: externalOrderType = ExternalOrderType.DEFAULT;
}
return externalOrderType;
}
@Override
public ExternalOrderType withAnyRemaining(OrderType orderType) {
if ( orderType == null ) {
return null;
}
ExternalOrderType externalOrderType;
switch ( orderType ) {
case RETAIL: externalOrderType = ExternalOrderType.RETAIL;
break;
case B2B: externalOrderType = ExternalOrderType.B2B;
break;
default: externalOrderType = ExternalOrderType.DEFAULT;
}
return externalOrderType;
}
@Override
public ExternalOrderType onlyWithMappings(OrderType orderType) {
if ( orderType == null ) {
return null;
}
ExternalOrderType externalOrderType;
switch ( orderType ) {
case EXTRA: externalOrderType = ExternalOrderType.SPECIAL;
break;
case STANDARD: externalOrderType = ExternalOrderType.DEFAULT;
break;
case NORMAL: externalOrderType = ExternalOrderType.DEFAULT;
break;
case RETAIL: externalOrderType = ExternalOrderType.RETAIL;
break;
case B2B: externalOrderType = ExternalOrderType.B2B;
break;
default: throw new CustomIllegalArgumentException( "Unexpected enum constant: " + orderType );
}
return externalOrderType;
}
@Override
public OrderType inverseOnlyWithMappings(ExternalOrderType orderType) {
if ( orderType == null ) {
return null;
}
OrderType orderType1;
switch ( orderType ) {
case SPECIAL: orderType1 = OrderType.EXTRA;
break;
case DEFAULT: orderType1 = OrderType.STANDARD;
break;
case RETAIL: orderType1 = OrderType.RETAIL;
break;
case B2B: orderType1 = OrderType.B2B;
break;
default: throw new CustomIllegalArgumentException( "Unexpected enum constant: " + orderType );
}
return orderType1;
}
}

101
processor/src/test/resources/fixtures/org/mapstruct/ap/test/value/exception/CustomUnexpectedValueMappingExceptionMapperImpl.java Normal file
View File

@ -0,0 +1,101 @@
/*
* Copyright MapStruct Authors.
*
* Licensed under the Apache License version 2.0, available at http://www.apache.org/licenses/LICENSE-2.0
*/
package org.mapstruct.ap.test.value.exception;
import javax.annotation.Generated;
import org.mapstruct.ap.test.value.CustomIllegalArgumentException;
import org.mapstruct.ap.test.value.ExternalOrderType;
import org.mapstruct.ap.test.value.OrderType;
@Generated(
value = "org.mapstruct.ap.MappingProcessor",
date = "2020-08-02T09:36:57+0200",
comments = "version: , compiler: javac, environment: Java 11.0.2 (AdoptOpenJDK)"
)
public class CustomUnexpectedValueMappingExceptionMapperImpl implements CustomUnexpectedValueMappingExceptionMapper {
@Override
public ExternalOrderType withAnyUnmapped(OrderType orderType) {
if ( orderType == null ) {
return null;
}
ExternalOrderType externalOrderType;
switch ( orderType ) {
default: externalOrderType = ExternalOrderType.DEFAULT;
}
return externalOrderType;
}
@Override
public ExternalOrderType withAnyRemaining(OrderType orderType) {
if ( orderType == null ) {
return null;
}
ExternalOrderType externalOrderType;
switch ( orderType ) {
case RETAIL: externalOrderType = ExternalOrderType.RETAIL;
break;
case B2B: externalOrderType = ExternalOrderType.B2B;
break;
default: externalOrderType = ExternalOrderType.DEFAULT;
}
return externalOrderType;
}
@Override
public ExternalOrderType onlyWithMappings(OrderType orderType) {
if ( orderType == null ) {
return null;
}
ExternalOrderType externalOrderType;
switch ( orderType ) {
case EXTRA: externalOrderType = ExternalOrderType.SPECIAL;
break;
case STANDARD: externalOrderType = ExternalOrderType.DEFAULT;
break;
case NORMAL: externalOrderType = ExternalOrderType.DEFAULT;
break;
case RETAIL: externalOrderType = ExternalOrderType.RETAIL;
break;
case B2B: externalOrderType = ExternalOrderType.B2B;
break;
default: throw new CustomIllegalArgumentException( "Unexpected enum constant: " + orderType );
}
return externalOrderType;
}
@Override
public OrderType inverseOnlyWithMappings(ExternalOrderType orderType) {
if ( orderType == null ) {
return null;
}
OrderType orderType1;
switch ( orderType ) {
case SPECIAL: orderType1 = OrderType.EXTRA;
break;
case DEFAULT: orderType1 = OrderType.STANDARD;
break;
case RETAIL: orderType1 = OrderType.RETAIL;
break;
case B2B: orderType1 = OrderType.B2B;
break;
default: throw new CustomIllegalArgumentException( "Unexpected enum constant: " + orderType );
}
return orderType1;
}
}

7
processor/src/test/resources/fixtures/org/mapstruct/ap/test/value/spi/CustomCheeseMapperImpl.java
View File

@ -6,6 +6,7 @@
package org.mapstruct.ap.test.value.spi;
import javax.annotation.processing.Generated;
import org.mapstruct.ap.test.value.CustomIllegalArgumentException;
@Generated(
value = "org.mapstruct.ap.MappingProcessor",
@ -31,7 +32,7 @@ public class CustomCheeseMapperImpl implements CustomCheeseMapper {
break;
case UNRECOGNIZED: cheeseType = null;
break;
default: throw new IllegalArgumentException( "Unexpected enum constant: " + cheese );
default: throw new CustomIllegalArgumentException( "Unexpected enum constant: " + cheese );
}
return cheeseType;
@ -50,7 +51,7 @@ public class CustomCheeseMapperImpl implements CustomCheeseMapper {
break;
case ROQUEFORT: customCheeseType = CustomCheeseType.CUSTOM_ROQUEFORT;
break;
default: throw new IllegalArgumentException( "Unexpected enum constant: " + cheese );
default: throw new CustomIllegalArgumentException( "Unexpected enum constant: " + cheese );
}
return customCheeseType;
@ -73,7 +74,7 @@ public class CustomCheeseMapperImpl implements CustomCheeseMapper {
break;
case UNRECOGNIZED: string = null;
break;
default: throw new IllegalArgumentException( "Unexpected enum constant: " + cheeseType );
default: throw new CustomIllegalArgumentException( "Unexpected enum constant: " + cheeseType );
}
return string;