001/*
002 * Portions of this software was developed by employees of the National Institute
003 * of Standards and Technology (NIST), an agency of the Federal Government and is
004 * being made available as a public service. Pursuant to title 17 United States
005 * Code Section 105, works of NIST employees are not subject to copyright
006 * protection in the United States. This software may be subject to foreign
007 * copyright. Permission in the United States and in foreign countries, to the
008 * extent that NIST may hold copyright, to use, copy, modify, create derivative
009 * works, and distribute this software and its documentation without fee is hereby
010 * granted on a non-exclusive basis, provided that this notice and disclaimer
011 * of warranty appears in all copies.
012 *
013 * THE SOFTWARE IS PROVIDED 'AS IS' WITHOUT ANY WARRANTY OF ANY KIND, EITHER
014 * EXPRESSED, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY
015 * THAT THE SOFTWARE WILL CONFORM TO SPECIFICATIONS, ANY IMPLIED WARRANTIES OF
016 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND FREEDOM FROM
017 * INFRINGEMENT, AND ANY WARRANTY THAT THE DOCUMENTATION WILL CONFORM TO THE
018 * SOFTWARE, OR ANY WARRANTY THAT THE SOFTWARE WILL BE ERROR FREE.  IN NO EVENT
019 * SHALL NIST BE LIABLE FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO, DIRECT,
020 * INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES, ARISING OUT OF, RESULTING FROM,
021 * OR IN ANY WAY CONNECTED WITH THIS SOFTWARE, WHETHER OR NOT BASED UPON WARRANTY,
022 * CONTRACT, TORT, OR OTHERWISE, WHETHER OR NOT INJURY WAS SUSTAINED BY PERSONS OR
023 * PROPERTY OR OTHERWISE, AND WHETHER OR NOT LOSS WAS SUSTAINED FROM, OR AROSE OUT
024 * OF THE RESULTS OF, OR USE OF, THE SOFTWARE OR SERVICES PROVIDED HEREUNDER.
025 */
026
027package gov.nist.secauto.metaschema.databind.model.annotations;
028
029import static java.lang.annotation.ElementType.TYPE;
030import static java.lang.annotation.RetentionPolicy.RUNTIME;
031
032import gov.nist.secauto.metaschema.core.model.IModule;
033
034import java.lang.annotation.Documented;
035import java.lang.annotation.Retention;
036import java.lang.annotation.Target;
037
038import edu.umd.cs.findbugs.annotations.NonNull;
039
040/**
041 * This annotation indicates that the target class represents a Module assembly.
042 */
043@Documented
044@Retention(RUNTIME)
045@Target(TYPE)
046public @interface MetaschemaAssembly {
047  /**
048   * Get the documentary formal name of the assembly.
049   * <p>
050   * If the value is "##none", then the description will be considered
051   * {@code null}.
052   *
053   * @return a markdown string or {@code "##none"} if no formal name is provided
054   */
055  @NonNull
056  String formalName() default Constants.NO_STRING_VALUE;
057
058  /**
059   * Get the documentary description of the assembly.
060   * <p>
061   * If the value is "##none", then the description will be considered
062   * {@code null}.
063   *
064   * @return a markdown string or {@code "##none"} if no description is provided
065   */
066  @NonNull
067  String description() default Constants.NO_STRING_VALUE;
068
069  /**
070   * Get the metaschema class that "owns" this assembly, which is the concrete
071   * implementation of the metaschema containing the assembly.
072   *
073   * @return the {@link IModule} class
074   */
075  Class<? extends IModule> moduleClass();
076
077  /**
078   * Name of the assembly.
079   *
080   * @return the name
081   */
082  @NonNull
083  String name();
084
085  /**
086   * Name of the root XML element or the JSON/YAML property.
087   * <p>
088   * If the value is "##none", then there is no root name.
089   *
090   * @return the name
091   */
092  @NonNull
093  String rootName() default Constants.NO_STRING_VALUE;
094
095  /**
096   * XML target namespace of the XML element.
097   * <p>
098   * If the value is "##default", then namespace is derived from the namespace
099   * 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}