Commit 78d8262eb48f8fcae56095d45fe6543b759ba5b5
1 parent
b0660532
Exists in
master
Adição de javadoc na classe br.gov.frameworkdemoiselle.annotation.Name
Showing
1 changed file
with
34 additions
and
0 deletions
Show diff stats
impl/core/src/main/java/br/gov/frameworkdemoiselle/annotation/Name.java
| @@ -49,6 +49,40 @@ import java.lang.annotation.Target; | @@ -49,6 +49,40 @@ import java.lang.annotation.Target; | ||
| 49 | import javax.enterprise.util.Nonbinding; | 49 | import javax.enterprise.util.Nonbinding; |
| 50 | import javax.inject.Qualifier; | 50 | import javax.inject.Qualifier; |
| 51 | 51 | ||
| 52 | +/** | ||
| 53 | + * This annotation is used to make passible: | ||
| 54 | + * | ||
| 55 | + * <ul> | ||
| 56 | + * <li>map an attribute that belongs to a configuration class in a key with a different name of this attribute</li> | ||
| 57 | + * <li>map a Resource Bundle to a file with different name of the created object</li> | ||
| 58 | + * </ul> | ||
| 59 | + * | ||
| 60 | + * <p> | ||
| 61 | + * The examples below shows how these annotation could be used: | ||
| 62 | + * <p> | ||
| 63 | + * | ||
| 64 | + * <blockquote> | ||
| 65 | + * | ||
| 66 | + * <pre> | ||
| 67 | + * public class NameConfig { | ||
| 68 | + * | ||
| 69 | + * @Name("other.name.attrib") | ||
| 70 | + * private int nameOfAttribute; | ||
| 71 | + * ... | ||
| 72 | + * } | ||
| 73 | + * | ||
| 74 | + * public class NameResourceBundle { | ||
| 75 | + * | ||
| 76 | + * @Name("other.name.bundle") | ||
| 77 | + * @Inject | ||
| 78 | + * private ResourceBundle bundle; | ||
| 79 | + * ... | ||
| 80 | + * } | ||
| 81 | + * </pre> | ||
| 82 | + * </blockquote> | ||
| 83 | + * | ||
| 84 | + * @author SERPRO | ||
| 85 | + */ | ||
| 52 | @Qualifier | 86 | @Qualifier |
| 53 | @Inherited | 87 | @Inherited |
| 54 | @Retention(RUNTIME) | 88 | @Retention(RUNTIME) |