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.ANNOTATION_TYPE;
030import static java.lang.annotation.RetentionPolicy.RUNTIME;
031
032import gov.nist.secauto.metaschema.core.model.constraint.IAllowedValuesConstraint;
033import gov.nist.secauto.metaschema.core.model.constraint.IConstraint;
034import gov.nist.secauto.metaschema.core.model.constraint.IConstraint.Level;
035
036import java.lang.annotation.Documented;
037import java.lang.annotation.Retention;
038import java.lang.annotation.Target;
039
040import edu.umd.cs.findbugs.annotations.NonNull;
041
042/**
043 * This annotation defines a set of values permitted to be used in the context
044 * of the containing annotation.
045 */
046@Documented
047@Retention(RUNTIME)
048@Target(ANNOTATION_TYPE)
049public @interface AllowedValues {
050  /**
051   * An optional identifier for the constraint, which must be unique to only this
052   * constraint.
053   *
054   * @return the identifier if provided or an empty string otherwise
055   */
056  @NonNull
057  String id() default "";
058
059  /**
060   * An optional formal name for the constraint.
061   *
062   * @return the formal name if provided or an empty string otherwise
063   */
064  @NonNull
065  String formalName() default "";
066
067  /**
068   * An optional description of the constraint.
069   *
070   * @return the description if provided or an empty string otherwise
071   */
072  @NonNull
073  String description() default "";
074
075  /**
076   * The significance of a violation of this constraint.
077   *
078   * @return the level
079   */
080  @NonNull
081  Level level() default IConstraint.Level.ERROR;
082
083  /**
084   * An optional metapath that points to the target flag or field value that the
085   * constraint applies to. If omitted the target will be ".", which means the
086   * target is the value of the {@link BoundFlag}, {@link BoundField} or
087   * {@link MetaschemaFieldValue} annotation the constraint appears on. In the
088   * prior case, this annotation may only appear on a {@link BoundField} if the
089   * field has no flags, which results in a {@link BoundField} annotation on a
090   * field instance with a scalar, data type value.
091   *
092   * @return the target metapath
093   */
094  @NonNull
095  String target() default IConstraint.DEFAULT_TARGET_METAPATH;
096
097  /**
098   * An optional set of properties associated with these allowed values.
099   *
100   * @return the properties or an empty array with no properties
101   */
102  Property[] properties() default {};
103
104  /**
105   * Get any allowed values for this constraint.
106   *
107   * @return an array of allowed value enumerations
108   */
109  @NonNull
110  AllowedValue[] values();
111
112  /**
113   * Indicates if the constraint allows other values not included in the
114   * enumerated list.
115   *
116   * @return {@code true} if other values are allowed or {@code false} otherwise
117   */
118  boolean allowOthers() default IAllowedValuesConstraint.DEFAULT_ALLOW_OTHER;
119
120  /**
121   * Indicates if the constraint can be extended by other constraints.
122   *
123   * @return the extension mode
124   */
125  @NonNull
126  IAllowedValuesConstraint.Extensible extensible() default IAllowedValuesConstraint.Extensible.MODEL;
127
128  /**
129   * The message to emit when the constraint is violated.
130   *
131   * @return the message or an empty string otherwise
132   */
133  @NonNull
134  String message() default "";
135
136  /**
137   * Any remarks about the constraint, encoded as an escaped Markdown string.
138   *
139   * @return an encoded markdown string or an empty string if no remarks are
140   *         provided
141   */
142  @NonNull
143  String remarks() default "";
144
145}