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

#707 Document to always use RetentionPolicy.CLASS in custom qualifier annotations.

Browse Source
This commit is contained in:
sjaakd 2016-08-28 10:25:30 +02:00
parent fd077047ca
commit 824fb993b5
2 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
core-common/src/main/java/org/mapstruct/Qualifier.java
View File

@ -44,6 +44,8 @@ import java.lang.annotation.Target;
* } * }
* </pre> * </pre>
* *
* <b>NOTE: </b>Qualifiers should have {@link RetentionPolicy#CLASS}.
*
* @author Sjaak Derksen * @author Sjaak Derksen
*/ */
@Target(ElementType.ANNOTATION_TYPE) @Target(ElementType.ANNOTATION_TYPE)

5
documentation/src/main/asciidoc/mapstruct-reference-guide.asciidoc
View File

@ -865,6 +865,11 @@ public class Titles {
---- ----
==== ====
[WARNING]
====
Please make sure the used retention policy equals retention policy `CLASS` (`@Retention(RetentionPolicy.CLASS)`).
====
[WARNING] [WARNING]
==== ====
A class / method annotated with a qualifier will not qualify anymore for mappings that do not have the `qualifiedBy` element. A class / method annotated with a qualifier will not qualify anymore for mappings that do not have the `qualifiedBy` element.