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
34 import java.lang.annotation.Documented;
35 import java.lang.annotation.Retention;
36 import java.lang.annotation.Target;
37
38 import edu.umd.cs.findbugs.annotations.NonNull;
39
40 /**
41 * This annotation indicates that the target class represents a Module assembly.
42 */
43 @Documented
44 @Retention(RUNTIME)
45 @Target(TYPE)
46 public @interface MetaschemaAssembly {
47 /**
48 * Get the documentary formal name of the assembly.
49 * <p>
50 * If the value is "##none", then the description will be considered
51 * {@code null}.
52 *
53 * @return a markdown string or {@code "##none"} if no formal name is provided
54 */
55 @NonNull
56 String formalName() default Constants.NO_STRING_VALUE;
57
58 /**
59 * Get the documentary description of the assembly.
60 * <p>
61 * If the value is "##none", then the description will be considered
62 * {@code null}.
63 *
64 * @return a markdown string or {@code "##none"} if no description is provided
65 */
66 @NonNull
67 String description() default Constants.NO_STRING_VALUE;
68
69 /**
70 * Get the metaschema class that "owns" this assembly, which is the concrete
71 * implementation of the metaschema containing the assembly.
72 *
73 * @return the {@link IModule} class
74 */
75 Class<? extends IModule> moduleClass();
76
77 /**
78 * Name of the assembly.
79 *
80 * @return the name
81 */
82 @NonNull
83 String name();
84
85 /**
86 * Name of the root XML element or the JSON/YAML property.
87 * <p>
88 * If the value is "##none", then there is no root name.
89 *
90 * @return the name
91 */
92 @NonNull
93 String rootName() default Constants.NO_STRING_VALUE;
94
95 /**
96 * XML target namespace of the XML element.
97 * <p>
98 * If the value is "##default", then namespace is derived from the namespace
99 * provided in the package-info.
100 *
101 * @return the namespace
102 */
103 @NonNull
104 String rootNamespace() default Constants.DEFAULT_STRING_VALUE;
105
106 /**
107 * Get any remarks for this assembly.
108 *
109 * @return a markdown string or {@code "##none"} if no remarks are provided
110 */
111 @NonNull
112 String remarks() default Constants.NO_STRING_VALUE;
113 }