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.TYPE;
031import static java.lang.annotation.RetentionPolicy.RUNTIME;
032
033import java.lang.annotation.Documented;
034import java.lang.annotation.Retention;
035import java.lang.annotation.Target;
036
037import edu.umd.cs.findbugs.annotations.NonNull;
038
039@Documented
040@Retention(RUNTIME)
041@Target({ TYPE, FIELD })
042public @interface ValueConstraints {
043  /**
044   * Get the allowed value constraints for the type or field this annotation is
045   * applied to.
046   *
047   * @return the allowed values or an empty array if no allowed values constraints
048   *         are defined
049   */
050  @NonNull
051  AllowedValues[] allowedValues() default {};
052
053  /**
054   * Get the matches constraints for the type or field this annotation is applied
055   * to.
056   *
057   * @return the allowed values or an empty array if no allowed values constraints
058   *         are defined
059   */
060  @NonNull
061  Matches[] matches() default {};
062
063  /**
064   * Get the index-has-key constraints for the type or field this annotation is
065   * applied to.
066   *
067   * @return the allowed values or an empty array if no allowed values constraints
068   *         are defined
069   */
070  @NonNull
071  IndexHasKey[] indexHasKey() default {};
072
073  /**
074   * Get the expect constraints for the type or field this annotation is applied
075   * to.
076   *
077   * @return the expected constraints or an empty array if no expected constraints
078   *         are defined
079   */
080  @NonNull
081  Expect[] expect() default {};
082}