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.FIELD;
030import static java.lang.annotation.ElementType.METHOD;
031import static java.lang.annotation.RetentionPolicy.RUNTIME;
032
033import gov.nist.secauto.metaschema.core.datatype.IDataTypeAdapter;
034
035import java.lang.annotation.Documented;
036import java.lang.annotation.Retention;
037import java.lang.annotation.Target;
038
039import edu.umd.cs.findbugs.annotations.NonNull;
040
041/**
042 * Identifies that the annotation target is a bound property that represents a
043 * Module flag.
044 */
045@Documented
046@Retention(RUNTIME)
047@Target({ FIELD, METHOD })
048public @interface BoundFlag {
049  /**
050   * Get the documentary formal name of the flag.
051   * <p>
052   * If the value is "##none", then the description will be considered
053   * {@code null}.
054   *
055   * @return a markdown string or {@code "##none"} if no formal name is provided
056   */
057  @NonNull
058  String formalName() default Constants.NO_STRING_VALUE;
059
060  /**
061   * Get the documentary description of the flag.
062   * <p>
063   * If the value is "##none", then the description will be considered
064   * {@code null}.
065   *
066   * @return a markdown string or {@code "##none"} if no description is provided
067   */
068  @NonNull
069  String description() default Constants.NO_STRING_VALUE;
070
071  /**
072   * The model name to use for singleton values. This name will be used for
073   * associated XML attributes and JSON properties.
074   * <p>
075   * If the value is "##none", then element name is derived from the JavaBean
076   * property name.
077   *
078   * @return the name
079   */
080  @NonNull
081  String useName() default Constants.NO_STRING_VALUE;
082
083  /**
084   * XML target namespace of the XML Schema element.
085   * <p>
086   * If the value is "##default", then namespace is derived from the namespace
087   * provided in the package-info. If the value is "##none", the namespace will be
088   * {@code null}.
089   *
090   * @return the namespace
091   */
092  @NonNull
093  String namespace() default Constants.NO_STRING_VALUE;
094
095  /**
096   * The default value of the flag represented as a string.
097   * <p>
098   * The value {@link Constants#NULL_VALUE} is used to indicate if no default
099   * value is provided.
100   *
101   * @return the default value
102   */
103  @NonNull
104  String defaultValue() default Constants.NULL_VALUE;
105
106  /**
107   * Specifies if the XML Schema attribute is optional or required. If true, then
108   * the JavaBean property is mapped to a XML Schema attribute that is required.
109   * Otherwise it is mapped to a XML Schema attribute that is optional.
110   *
111   * @return {@code true} if the flag must occur, or {@code false} otherwise
112   */
113  boolean required() default false;
114
115  /**
116   * The Module data type adapter for the field's value.
117   *
118   * @return the data type adapter
119   */
120  @NonNull
121  Class<? extends IDataTypeAdapter<?>> typeAdapter() default NullJavaTypeAdapter.class;
122
123  /**
124   * Get any remarks for this flag.
125   *
126   * @return a markdown string or {@code "##none"} if no remarks are provided
127   */
128  @NonNull
129  String remarks() default Constants.NO_STRING_VALUE;
130}