io.github.linpeilie.annotations

Annotation Type AutoMapping

@Target(value={FIELD,METHOD,ANNOTATION_TYPE})
 @Retention(value=CLASS)
public @interface AutoMapping

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	conditionExpression
String[]	conditionQualifiedByName String-based form of qualifiers for condition / presence check methods; When looking for a suitable presence check method for a given property, MapStruct will only consider those methods carrying directly or indirectly (i.e.
String	constant
String	dateFormat
String	defaultExpression
String	defaultValue 默认值
String[]	dependsOn One or more properties of the result type on which the mapped property depends.
String	expression
boolean	ignore
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.NullValuePropertyMappingStrategy	nullValuePropertyMappingStrategy The strategy to be applied when the source property is null or not present.
String	numberFormat
Class<? extends Annotation>[]	qualifiedBy A qualifier can be specified to aid the selection process of a suitable mapper.
String[]	qualifiedByName String-based form of qualifiers; When looking for a suitable mapping method for a given property, MapStruct will only consider those methods carrying directly or indirectly (i.e.
boolean	reverseConvertGenerate 是否生成反向转换的逻辑。 该属性只针对复杂转换，且 MapStruct 默认不会自动转换的属性生效，比如多层结构：a.b 转换为当前类的 c
String	source 来源，默认取当前字段名称 - 可以是当前类中的属性名 - 也可以是属性名.属性名，例如：address.city.name
String	target
Class<?>	targetClass

Element Detail

targetClass

public abstract Class<?> targetClass

Default:

io.github.linpeilie.DefaultMapping.class

reverseConvertGenerate

public abstract boolean reverseConvertGenerate

是否生成反向转换的逻辑。 该属性只针对复杂转换，且 MapStruct 默认不会自动转换的属性生效，比如多层结构：a.b 转换为当前类的 c

Returns:

true : 生成反向转换的逻辑 false : 不生成反向转换的逻辑

Default:

true

source

public abstract String source

来源，默认取当前字段名称 - 可以是当前类中的属性名 - 也可以是属性名.属性名，例如：address.city.name

Returns:

当前类中的属性

Default:

""

target

public abstract String target

Default:

""

dateFormat

public abstract String dateFormat

Default:

""

numberFormat

public abstract String numberFormat

Default:

""

constant

public abstract String constant

Returns:

常量值

Since:

1.4.2

Default:

""

expression

public abstract String expression

Default:

""

defaultExpression

public abstract String defaultExpression

Default:

""

conditionExpression

public abstract String conditionExpression

Default:

""

ignore

public abstract boolean ignore

Default:

false

defaultValue

public abstract String defaultValue

默认值

Returns:

当源属性为null时，设置的默认值

Default:

""

qualifiedBy

public abstract Class<? extends Annotation>[] qualifiedBy

A qualifier can be specified to aid the selection process of a suitable mapper. This is useful in case multiple mapping methods (hand written or generated) qualify and thus would result in an 'Ambiguous mapping methods found' error. A qualifier is a custom annotation and can be placed on a hand written mapper class or a method.

Note that defaultValue() usage will also be converted using this qualifier. qualifier 可以置顶限定符来帮助选择合适的转换方法。qualifier 是一个自定义的注解，可以标注在 mapper 类或者方法上。

Note that defaultValue() usage will also be converted using this qualifier.

Returns:

the qualifiers

Since:

1.4.2

See Also:

Qualifier

Default:

{}

qualifiedByName

public abstract String[] qualifiedByName

String-based form of qualifiers; When looking for a suitable mapping method for a given property, MapStruct will only consider those methods carrying directly or indirectly (i.e. on the class-level) a Named annotation for each of the specified qualifier names.

Note that annotation-based qualifiers are generally preferable as they allow more easily to find references and are safe for refactorings, but name-based qualifiers can be a less verbose alternative when requiring a large number of qualifiers as no custom annotation types are needed.

Note that defaultValue() usage will also be converted using this qualifier.

Returns:

One or more qualifier name(s)

Since:

1.4.0

See Also:

Named

Default:

{}

conditionQualifiedByName

public abstract String[] conditionQualifiedByName

String-based form of qualifiers for condition / presence check methods; When looking for a suitable presence check method for a given property, MapStruct will only consider those methods carrying directly or indirectly (i.e. on the class-level) a Named annotation for each of the specified qualifier names. This is similar like qualifiedByName() but it is only applied for Condition methods.

Note that annotation-based qualifiers are generally preferable as they allow more easily to find references and are safe for refactorings, but name-based qualifiers can be a less verbose alternative when requiring a large number of qualifiers as no custom annotation types are needed.

Returns:

One or more qualifier name(s)

Since:

1.4.0

See Also:

qualifiedByName(), Named

Default:

{}

dependsOn

public abstract String[] dependsOn

One or more properties of the result type on which the mapped property depends. The generated method implementation will invoke the setters of the result type ordered so that the given dependency relationship(s) are satisfied. Useful in case one property setter depends on the state of another property of the result type.

An error will be raised in case a cycle in the dependency relationships is detected.

Returns:

the dependencies of the mapped property

Since:

1.4.0

Default:

{}

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, Mapper or BeanMapping.

Returns:

strategy how to do null checking

Since:

1.4.2

Default:

org.mapstruct.NullValueCheckStrategy.ON_IMPLICIT_CONVERSION

nullValuePropertyMappingStrategy

public abstract org.mapstruct.NullValuePropertyMappingStrategy nullValuePropertyMappingStrategy

The strategy to be applied when the source property is null or not present. If no strategy is configured, the strategy given via MapperConfig.nullValuePropertyMappingStrategy(), BeanMapping.nullValuePropertyMappingStrategy() or Mapper.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

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