AutoMapper (mapstruct-plus 1.4.8 API)

@Target(value=TYPE)
 @Retention(value=CLASS)
public @interface AutoMapper

Author:: linpl

Required Element Summary

Required Elements
Modifier and Type Required Element and Description

Class<?> target

Required Elements
Modifier and Type	Required Element and Description
`Class<?>`	`target`

Optional Element Summary

Optional Elements
Modifier and Type	Optional Element and Description
`org.mapstruct.CollectionMappingStrategy`	`collectionMappingStrategy` The strategy to be applied when propagating the value of collection-typed properties.
`boolean`	`convertGenerate` 是否生成转换的接口，当只想生成反向接口时，可以指定当前属性为 `false`
`boolean`	`cycleAvoiding` 是否需要避免对象循环嵌套
`Class<?>[]`	`imports`
`String`	`mapperName` 生成的 Mapper 接口名称
`String`	`mapperNameSuffix` 生成的 Mapper 接口名称后缀，生成的反向转换接口同时生效
`Class<? extends Annotation>`	`mappingControl` Allows detailed control over the mapping process.
`org.mapstruct.NullValueCheckStrategy`	`nullValueCheckStrategy` Determines when to include a null check on the source property value of a bean mapping.
`org.mapstruct.NullValueMappingStrategy`	`nullValueIterableMappingStrategy` The strategy to be applied when `null` is passed as source argument value to an `IterableMapping` of this mapper.
`org.mapstruct.NullValueMappingStrategy`	`nullValueMappingStrategy` The strategy to be applied when `null` is passed as source argument value to the methods of this mapper.
`org.mapstruct.NullValuePropertyMappingStrategy`	`nullValuePropertyMappingStrategy` The strategy to be applied when a source bean property is `null` or not present.
`boolean`	`reverseConvertGenerate` 是否生成反向转换的接口
`org.mapstruct.ReportingPolicy`	`typeConversionPolicy` How lossy (narrowing) conversion, for instance long to integer should be reported.
`org.mapstruct.ReportingPolicy`	`unmappedSourcePolicy` How unmapped properties of the source type of a mapping should be reported.
`org.mapstruct.ReportingPolicy`	`unmappedTargetPolicy` How unmapped properties of the target type of a mapping should be reported.
`Class<?>[]`	`useEnums` 转换需要依赖的枚举，依赖的枚举，需要被 AutoEnumMapper 所注解
`Class<?>[]`	`uses`

- Element Detail
  - target
```
public abstract Class<?> target
```
- - uses
```
public abstract Class<?>[] uses
```
    Default:
    
    {}
- - useEnums
```
public abstract Class<?>[] useEnums
```
    转换需要依赖的枚举，依赖的枚举，需要被 AutoEnumMapper 所注解
    
    Default:
    
    {}
- - imports
```
public abstract Class<?>[] imports
```
    Default:
    
    {}
- - convertGenerate
```
public abstract boolean convertGenerate
```
    是否生成转换的接口，当只想生成反向接口时，可以指定当前属性为 false
    
    Returns:
    
    true 生成类型转换的接口 false 不生成类型转换的接口
    
    Default:
    
    true
- - mapperName
```
public abstract String mapperName
```
    生成的 Mapper 接口名称
    
    Returns:
    
    生成的 Mapper 接口名称
    
    Default:
    
    ""
- - mapperNameSuffix
```
public abstract String mapperNameSuffix
```
    生成的 Mapper 接口名称后缀，生成的反向转换接口同时生效
    
    Returns:
    
    生成的 Mapper 接口名称后缀
    
    Default:
    
    ""
- - reverseConvertGenerate
```
public abstract boolean reverseConvertGenerate
```
    是否生成反向转换的接口
    
    Returns:
    
    true : 生成反向转换的接口 false : 不生成反向转换的接口
    
    Default:
    
    true
- - cycleAvoiding
```
public abstract boolean cycleAvoiding
```
    是否需要避免对象循环嵌套
    循环嵌套：A中有属性类型B，B中有属性类型A，且可能对象之间互相引用
    
    Returns:
    
    true: 需要避免对象循环嵌套；false：不需要
    
    Default:
    
    false
- - unmappedSourcePolicy
```
public abstract org.mapstruct.ReportingPolicy unmappedSourcePolicy
```
    How unmapped properties of the source type of a mapping should be reported. The method overrides an unmappedSourcePolicy set in a central configuration
    
    Returns:
    
    The reporting policy for unmapped source properties.
    
    Since:
    
    1.4.2
    
    Default:
    
    org.mapstruct.ReportingPolicy.IGNORE
- - unmappedTargetPolicy
```
public abstract org.mapstruct.ReportingPolicy unmappedTargetPolicy
```
    How unmapped properties of the target type of a mapping should be reported. The method overrides an unmappedTargetPolicy set in a central configuration
    
    Returns:
    
    The reporting policy for unmapped target properties.
    
    Since:
    
    1.4.2
    
    Default:
    
    org.mapstruct.ReportingPolicy.WARN
- - typeConversionPolicy
```
public abstract org.mapstruct.ReportingPolicy typeConversionPolicy
```
    How lossy (narrowing) conversion, for instance long to integer should be reported. The method overrides an typeConversionPolicy set in a central configuration
    
    Returns:
    
    The reporting policy for unmapped target properties.
    
    Since:
    
    1.4.2
    
    Default:
    
    org.mapstruct.ReportingPolicy.IGNORE
- - collectionMappingStrategy
```
public abstract org.mapstruct.CollectionMappingStrategy collectionMappingStrategy
```
    The strategy to be applied when propagating the value of collection-typed properties. By default, only JavaBeans accessor methods (setters or getters) will be used, but it is also possible to invoke a corresponding adder method for each element of the source collection (e.g. orderDto.addOrderLine()).
    Any setting given for this attribute will take precedence over MapperConfig.collectionMappingStrategy(), if present.
    
    Returns:
    
    The strategy applied when propagating the value of collection-typed properties.
    
    Since:
    
    1.4.2
    
    Default:
    
    org.mapstruct.CollectionMappingStrategy.ACCESSOR_ONLY
- - nullValueMappingStrategy
```
public abstract org.mapstruct.NullValueMappingStrategy nullValueMappingStrategy
```
    The strategy to be applied when null is passed as source argument value to the methods of this mapper. If no strategy is configured, the strategy given via MapperConfig.nullValueMappingStrategy() will be applied, using NullValueMappingStrategy.RETURN_NULL by default.
    
    Returns:
    
    The strategy to be applied when null is passed as source value to the methods of this mapper.
    
    Since:
    
    1.4.2
    
    Default:
    
    org.mapstruct.NullValueMappingStrategy.RETURN_NULL
- - nullValueIterableMappingStrategy
```
public abstract org.mapstruct.NullValueMappingStrategy nullValueIterableMappingStrategy
```
    The strategy to be applied when null is passed as source argument value to an IterableMapping of this mapper. If unset, the strategy set with nullValueMappingStrategy() will be applied. If neither strategy is configured, the strategy given via MapperConfig.nullValueIterableMappingStrategy() will be applied, using NullValueMappingStrategy.RETURN_NULL by default.
    
    Returns:
    
    The strategy to be applied when null is passed as source value to an IterableMapping of this mapper.
    
    Since:
    
    1.4.2
    
    Default:
    
    org.mapstruct.NullValueMappingStrategy.RETURN_NULL
- - nullValuePropertyMappingStrategy
```
public abstract org.mapstruct.NullValuePropertyMappingStrategy nullValuePropertyMappingStrategy
```
    The strategy to be applied when a source bean property is null or not present. If no strategy is configured, the strategy given via MapperConfig.nullValuePropertyMappingStrategy() will be applied, NullValuePropertyMappingStrategy.SET_TO_NULL will be used by default.
    
    Returns:
    
    The strategy to be applied when null is passed as source property value or the source property is not present.
    
    Since:
    
    1.4.2
    
    Default:
    
    org.mapstruct.NullValuePropertyMappingStrategy.SET_TO_NULL
- - nullValueCheckStrategy
```
public abstract org.mapstruct.NullValueCheckStrategy nullValueCheckStrategy
```
    Determines when to include a null check on the source property value of a bean mapping. Can be overridden by the one on MapperConfig, BeanMapping or Mapping.
    
    Returns:
    
    strategy how to do null checking
    
    Since:
    
    1.4.2
    
    Default:
    
    org.mapstruct.NullValueCheckStrategy.ON_IMPLICIT_CONVERSION
- - mappingControl
```
public abstract Class<? extends Annotation> mappingControl
```
    Allows detailed control over the mapping process.
    
    Returns:
    
    the mapping control
    
    Since:
    
    1.4.2
    
    See Also:
    
    DeepClone, NoComplexMapping, MappingControl
    
    Default:
    
    org.mapstruct.control.MappingControl.class

Annotation Type AutoMapper

Required Element Summary

Optional Element Summary

Element Detail

target

uses

useEnums

imports

convertGenerate

mapperName

mapperNameSuffix

reverseConvertGenerate

cycleAvoiding

unmappedSourcePolicy

unmappedTargetPolicy

typeConversionPolicy

collectionMappingStrategy

nullValueMappingStrategy

nullValueIterableMappingStrategy

nullValuePropertyMappingStrategy

nullValueCheckStrategy

mappingControl