1 /*
2 * Portions of this software was developed by employees of the National Institute
3 * of Standards and Technology (NIST), an agency of the Federal Government and is
4 * being made available as a public service. Pursuant to title 17 United States
5 * Code Section 105, works of NIST employees are not subject to copyright
6 * protection in the United States. This software may be subject to foreign
7 * copyright. Permission in the United States and in foreign countries, to the
8 * extent that NIST may hold copyright, to use, copy, modify, create derivative
9 * works, and distribute this software and its documentation without fee is hereby
10 * granted on a non-exclusive basis, provided that this notice and disclaimer
11 * of warranty appears in all copies.
12 *
13 * THE SOFTWARE IS PROVIDED 'AS IS' WITHOUT ANY WARRANTY OF ANY KIND, EITHER
14 * EXPRESSED, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY
15 * THAT THE SOFTWARE WILL CONFORM TO SPECIFICATIONS, ANY IMPLIED WARRANTIES OF
16 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND FREEDOM FROM
17 * INFRINGEMENT, AND ANY WARRANTY THAT THE DOCUMENTATION WILL CONFORM TO THE
18 * SOFTWARE, OR ANY WARRANTY THAT THE SOFTWARE WILL BE ERROR FREE. IN NO EVENT
19 * SHALL NIST BE LIABLE FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO, DIRECT,
20 * INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES, ARISING OUT OF, RESULTING FROM,
21 * OR IN ANY WAY CONNECTED WITH THIS SOFTWARE, WHETHER OR NOT BASED UPON WARRANTY,
22 * CONTRACT, TORT, OR OTHERWISE, WHETHER OR NOT INJURY WAS SUSTAINED BY PERSONS OR
23 * PROPERTY OR OTHERWISE, AND WHETHER OR NOT LOSS WAS SUSTAINED FROM, OR AROSE OUT
24 * OF THE RESULTS OF, OR USE OF, THE SOFTWARE OR SERVICES PROVIDED HEREUNDER.
25 */
26
27 package gov.nist.secauto.metaschema.databind.model.annotations;
28
29 import static java.lang.annotation.ElementType.TYPE;
30 import static java.lang.annotation.RetentionPolicy.RUNTIME;
31
32 import gov.nist.secauto.metaschema.core.model.IModule;
33 import gov.nist.secauto.metaschema.core.model.MetaschemaModelConstants;
34
35 import java.lang.annotation.Documented;
36 import java.lang.annotation.Retention;
37 import java.lang.annotation.Target;
38
39 import edu.umd.cs.findbugs.annotations.NonNull;
40
41 /**
42 * This annotation indicates that the target class represents a Module field.
43 * <p>
44 * Classes with this annotation must have a field with the
45 * {@link MetaschemaFieldValue} annotation.
46 */
47 @Documented
48 @Retention(RUNTIME)
49 @Target(TYPE)
50 public @interface MetaschemaField {
51 /**
52 * Get the documentary formal name of the field.
53 * <p>
54 * If the value is "##none", then the description will be considered
55 * {@code null}.
56 *
57 * @return a markdown string or {@code "##none"} if no formal name is provided
58 */
59 @NonNull
60 String formalName() default Constants.NO_STRING_VALUE;
61
62 /**
63 * Get the documentary description of the field.
64 * <p>
65 * If the value is "##none", then the description will be considered
66 * {@code null}.
67 *
68 * @return a markdown string or {@code "##none"} if no description is provided
69 */
70 @NonNull
71 String description() default Constants.NO_STRING_VALUE;
72
73 /**
74 * Name of the field.
75 *
76 * @return the name
77 */
78 @NonNull
79 String name();
80
81 @NonNull
82 String useName() default Constants.NO_STRING_VALUE;
83
84 /**
85 * Get the metaschema class that "owns" this assembly, which is the concrete
86 * implementation of the metaschema containing the assembly.
87 *
88 * @return the class that extends {@link IModule}
89 */
90 Class<? extends IModule> moduleClass();
91
92 /**
93 * If the data type allows it, determines if the field's value must be wrapped
94 * with an XML element whose name is the specified {@link #name()} and namespace
95 * is derived from the namespace of the instance.
96 *
97 * @return {@code true} if the field must be wrapped, or {@code false} otherwise
98 */
99 boolean inXmlWrapped() default MetaschemaModelConstants.DEFAULT_FIELD_IN_XML_WRAPPED;
100
101 /**
102 * Get any remarks for this field.
103 *
104 * @return a markdown string or {@code "##none"} if no remarks are provided
105 */
106 @NonNull
107 String remarks() default Constants.NO_STRING_VALUE;
108 }