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.RetentionPolicy.RUNTIME;
030
031import gov.nist.secauto.metaschema.core.model.IModule;
032
033import java.lang.annotation.ElementType;
034import java.lang.annotation.Retention;
035import java.lang.annotation.Target;
036
037import edu.umd.cs.findbugs.annotations.NonNull;
038
039@Retention(RUNTIME)
040@Target(ElementType.TYPE)
041public @interface Module {
042  /**
043   * Get the classes representing the global fields defined on this Module.
044   *
045   * @return an array of field classes
046   */
047  @NonNull
048  Class<?>[] fields() default {};
049
050  /**
051   * Get the classes representing the global assemblies defined on this Module.
052   *
053   * @return an array of assembly classes
054   */
055  @NonNull
056  Class<?>[] assemblies() default {};
057
058  /**
059   * Get the classes representing the Metaschemas imported by this Module.
060   *
061   * @return an array of imported Metaschemas
062   */
063  @NonNull
064  Class<? extends IModule>[] imports() default {};
065
066  /**
067   * Get any remarks for this metaschema.
068   *
069   * @return a markdown string or {@code "##none"} if no remarks are provided
070   */
071  @NonNull
072  String remarks() default Constants.NO_STRING_VALUE;
073}