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.RetentionPolicy.RUNTIME;
031
032import gov.nist.secauto.metaschema.core.datatype.IDataTypeAdapter;
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 * Identifies a field on a class annotated with the {@link MetaschemaField}
042 * annotation as the Module field's value.
043 */
044@Documented
045@Retention(RUNTIME)
046@Target({ FIELD })
047public @interface MetaschemaFieldValue {
048  /**
049   * The Module data type adapter for the field's value.
050   *
051   * @return the data type adapter
052   */
053  Class<? extends IDataTypeAdapter<?>> typeAdapter() default NullJavaTypeAdapter.class;
054
055  /**
056   * The default value of the flag represented as a string.
057   * <p>
058   * The value {@link Constants#NULL_VALUE} is used to indicate if no default
059   * value is provided.
060   *
061   * @return the default value
062   */
063  @NonNull
064  String defaultValue() default Constants.NULL_VALUE;
065
066  /**
067   * The name of the JSON property that contains the field's value. If this value
068   * is provided, the the name will be used as the property name. Otherwise, the
069   * property name will default to a value defined by the data type.
070   * <p>
071   * Use of this annotation is mutually exclusive with the
072   * {@link JsonFieldValueKeyFlag} annotation.
073   *
074   * @return the name
075   */
076  @NonNull
077  String valueKeyName() default Constants.NO_STRING_VALUE;
078}