mirror of
https://github.com/mapstruct/mapstruct.git
synced 2025-07-12 00:00:08 +08:00
#3309 Add BeanMapping#unmappedSourcePolicy
This commit is contained in:
parent
28d827a724
commit
279ab22482
@ -152,6 +152,17 @@ public @interface BeanMapping {
|
|||||||
*/
|
*/
|
||||||
String[] ignoreUnmappedSourceProperties() default {};
|
String[] ignoreUnmappedSourceProperties() default {};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* How unmapped properties of the source type of a mapping should be reported.
|
||||||
|
* If no policy is configured, the policy given via {@link MapperConfig#unmappedSourcePolicy()} or
|
||||||
|
* {@link Mapper#unmappedSourcePolicy()} will be applied, using {@link ReportingPolicy#IGNORE} by default.
|
||||||
|
*
|
||||||
|
* @return The reporting policy for unmapped source properties.
|
||||||
|
*
|
||||||
|
* @since 1.6
|
||||||
|
*/
|
||||||
|
ReportingPolicy unmappedSourcePolicy() default ReportingPolicy.IGNORE;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* How unmapped properties of the target type of a mapping should be reported.
|
* How unmapped properties of the target type of a mapping should be reported.
|
||||||
* If no policy is configured, the policy given via {@link MapperConfig#unmappedTargetPolicy()} or
|
* If no policy is configured, the policy given via {@link MapperConfig#unmappedTargetPolicy()} or
|
||||||
|
@ -1740,7 +1740,7 @@ public class BeanMappingMethod extends NormalTypeMappingMethod {
|
|||||||
if ( method.getOptions().getBeanMapping().isignoreByDefault() ) {
|
if ( method.getOptions().getBeanMapping().isignoreByDefault() ) {
|
||||||
return ReportingPolicyGem.IGNORE;
|
return ReportingPolicyGem.IGNORE;
|
||||||
}
|
}
|
||||||
return method.getOptions().getMapper().unmappedSourcePolicy();
|
return method.getOptions().getBeanMapping().unmappedSourcePolicy();
|
||||||
}
|
}
|
||||||
|
|
||||||
private void reportErrorForUnmappedSourcePropertiesIfRequired() {
|
private void reportErrorForUnmappedSourcePropertiesIfRequired() {
|
||||||
|
@ -113,6 +113,7 @@ public class BeanMappingOptions extends DelegatingOptions {
|
|||||||
&& !gem.nullValueMappingStrategy().hasValue()
|
&& !gem.nullValueMappingStrategy().hasValue()
|
||||||
&& !gem.subclassExhaustiveStrategy().hasValue()
|
&& !gem.subclassExhaustiveStrategy().hasValue()
|
||||||
&& !gem.unmappedTargetPolicy().hasValue()
|
&& !gem.unmappedTargetPolicy().hasValue()
|
||||||
|
&& !gem.unmappedSourcePolicy().hasValue()
|
||||||
&& !gem.ignoreByDefault().hasValue()
|
&& !gem.ignoreByDefault().hasValue()
|
||||||
&& !gem.builder().hasValue() ) {
|
&& !gem.builder().hasValue() ) {
|
||||||
|
|
||||||
@ -179,6 +180,15 @@ public class BeanMappingOptions extends DelegatingOptions {
|
|||||||
.orElse( next().unmappedTargetPolicy() );
|
.orElse( next().unmappedTargetPolicy() );
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public ReportingPolicyGem unmappedSourcePolicy() {
|
||||||
|
return Optional.ofNullable( beanMapping ).map( BeanMappingGem::unmappedSourcePolicy )
|
||||||
|
.filter( GemValue::hasValue )
|
||||||
|
.map( GemValue::getValue )
|
||||||
|
.map( ReportingPolicyGem::valueOf )
|
||||||
|
.orElse( next().unmappedSourcePolicy() );
|
||||||
|
}
|
||||||
|
|
||||||
@Override
|
@Override
|
||||||
public BuilderGem getBuilder() {
|
public BuilderGem getBuilder() {
|
||||||
return Optional.ofNullable( beanMapping ).map( BeanMappingGem::builder )
|
return Optional.ofNullable( beanMapping ).map( BeanMappingGem::builder )
|
||||||
|
@ -110,4 +110,5 @@ public class UnmappedSourceTest {
|
|||||||
)
|
)
|
||||||
public void shouldLeaveUnmappedSourcePropertyUnsetWithWarnPolicySetViaProcessorOption() {
|
public void shouldLeaveUnmappedSourcePropertyUnsetWithWarnPolicySetViaProcessorOption() {
|
||||||
}
|
}
|
||||||
|
|
||||||
}
|
}
|
||||||
|
@ -0,0 +1,18 @@
|
|||||||
|
/*
|
||||||
|
* 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.unmappedsource.beanmapping;
|
||||||
|
|
||||||
|
import org.mapstruct.BeanMapping;
|
||||||
|
import org.mapstruct.Mapper;
|
||||||
|
import org.mapstruct.ReportingPolicy;
|
||||||
|
|
||||||
|
@Mapper(unmappedSourcePolicy = ReportingPolicy.WARN)
|
||||||
|
public interface BeanMappingSourcePolicyErroneousMapper {
|
||||||
|
|
||||||
|
@BeanMapping(unmappedSourcePolicy = ReportingPolicy.ERROR)
|
||||||
|
Target map(Source source);
|
||||||
|
|
||||||
|
}
|
@ -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.unmappedsource.beanmapping;
|
||||||
|
|
||||||
|
import org.mapstruct.BeanMapping;
|
||||||
|
import org.mapstruct.Mapper;
|
||||||
|
import org.mapstruct.ReportingPolicy;
|
||||||
|
import org.mapstruct.factory.Mappers;
|
||||||
|
|
||||||
|
@Mapper(unmappedSourcePolicy = ReportingPolicy.ERROR)
|
||||||
|
public interface BeanMappingSourcePolicyMapper {
|
||||||
|
|
||||||
|
BeanMappingSourcePolicyMapper MAPPER =
|
||||||
|
Mappers.getMapper( BeanMappingSourcePolicyMapper.class );
|
||||||
|
|
||||||
|
@BeanMapping(unmappedSourcePolicy = ReportingPolicy.WARN)
|
||||||
|
Target map(Source source);
|
||||||
|
|
||||||
|
@BeanMapping(unmappedSourcePolicy = ReportingPolicy.IGNORE)
|
||||||
|
Target map2(Source source);
|
||||||
|
|
||||||
|
}
|
@ -0,0 +1,30 @@
|
|||||||
|
/*
|
||||||
|
* 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.unmappedsource.beanmapping;
|
||||||
|
|
||||||
|
public class Source {
|
||||||
|
|
||||||
|
private int foo;
|
||||||
|
|
||||||
|
private int bar;
|
||||||
|
|
||||||
|
public int getFoo() {
|
||||||
|
return foo;
|
||||||
|
}
|
||||||
|
|
||||||
|
public void setFoo(int foo) {
|
||||||
|
this.foo = foo;
|
||||||
|
}
|
||||||
|
|
||||||
|
public int getBar() {
|
||||||
|
return bar;
|
||||||
|
}
|
||||||
|
|
||||||
|
public void setBar(int bar) {
|
||||||
|
this.bar = bar;
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
@ -0,0 +1,20 @@
|
|||||||
|
/*
|
||||||
|
* 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.unmappedsource.beanmapping;
|
||||||
|
|
||||||
|
public class Target {
|
||||||
|
|
||||||
|
private int foo;
|
||||||
|
|
||||||
|
public int getFoo() {
|
||||||
|
return foo;
|
||||||
|
}
|
||||||
|
|
||||||
|
public void setFoo(int foo) {
|
||||||
|
this.foo = foo;
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
@ -0,0 +1,67 @@
|
|||||||
|
/*
|
||||||
|
* 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.unmappedsource.beanmapping;
|
||||||
|
|
||||||
|
import static org.assertj.core.api.Assertions.assertThat;
|
||||||
|
|
||||||
|
import javax.tools.Diagnostic.Kind;
|
||||||
|
|
||||||
|
import org.mapstruct.ap.testutil.IssueKey;
|
||||||
|
import org.mapstruct.ap.testutil.ProcessorTest;
|
||||||
|
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;
|
||||||
|
|
||||||
|
@IssueKey("3309")
|
||||||
|
class UnmappedSourceTest {
|
||||||
|
|
||||||
|
@ProcessorTest
|
||||||
|
@WithClasses({ Source.class, Target.class, BeanMappingSourcePolicyMapper.class })
|
||||||
|
@ExpectedCompilationOutcome(
|
||||||
|
value = CompilationResult.SUCCEEDED,
|
||||||
|
diagnostics = {
|
||||||
|
@Diagnostic(type = BeanMappingSourcePolicyMapper.class,
|
||||||
|
kind = Kind.WARNING,
|
||||||
|
line = 20,
|
||||||
|
message = "Unmapped source property: \"bar\".")
|
||||||
|
}
|
||||||
|
)
|
||||||
|
public void shouldCompileWithUnmappedSourcePolicySetToWarnWithBeanMapping() {
|
||||||
|
Source source = new Source();
|
||||||
|
Source source2 = new Source();
|
||||||
|
|
||||||
|
source.setFoo( 10 );
|
||||||
|
source.setBar( 20 );
|
||||||
|
|
||||||
|
source2.setFoo( 1 );
|
||||||
|
source2.setBar( 2 );
|
||||||
|
|
||||||
|
Target target = BeanMappingSourcePolicyMapper.MAPPER.map( source );
|
||||||
|
Target target2 = BeanMappingSourcePolicyMapper.MAPPER.map2( source2 );
|
||||||
|
|
||||||
|
assertThat( target ).isNotNull();
|
||||||
|
assertThat( target.getFoo() ).isEqualTo( 10 );
|
||||||
|
|
||||||
|
assertThat( target2 ).isNotNull();
|
||||||
|
assertThat( target2.getFoo() ).isEqualTo( 1 );
|
||||||
|
}
|
||||||
|
|
||||||
|
@ProcessorTest
|
||||||
|
@WithClasses({ Source.class, Target.class, BeanMappingSourcePolicyErroneousMapper.class })
|
||||||
|
@ExpectedCompilationOutcome(
|
||||||
|
value = CompilationResult.FAILED,
|
||||||
|
diagnostics = {
|
||||||
|
@Diagnostic(type = BeanMappingSourcePolicyErroneousMapper.class,
|
||||||
|
kind = Kind.ERROR,
|
||||||
|
line = 16,
|
||||||
|
message = "Unmapped source property: \"bar\".")
|
||||||
|
}
|
||||||
|
)
|
||||||
|
public void shouldErrorWithUnmappedSourcePolicySetToErrorWithBeanMapping() {
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
Loading…
x
Reference in New Issue
Block a user