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.model.MetaschemaModelConstants; 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 that the annotation target is a bound property that references a 042 * Module field. 043 * <p> 044 * For XML serialization, the {@link #useName()} identifies the name of the 045 * element to use and the {@link #namespace()} identifies the namespace of this 046 * element. 047 * <p> 048 * For JSON and YAML serializations, the {@link #useName()} identifies the 049 * property/item name to use. 050 * <p> 051 * The field must be either: 052 * <ol> 053 * <li>A Module data type or a collection whose item value is Module data type, 054 * with a {@link BoundFieldValue} annotation on the field. 055 * <li>A type or a collection whose item value is a type based on a class with a 056 * {@link MetaschemaField} annotation.</li> 057 * </ol> 058 */ 059@Documented 060@Retention(RUNTIME) 061@Target({ FIELD }) 062public @interface BoundField { 063 /** 064 * Get the documentary formal name of the field. 065 * <p> 066 * If the value is "##none", then the description will be considered 067 * {@code null}. 068 * 069 * @return a markdown string or {@code "##none"} if no formal name is provided 070 */ 071 @NonNull 072 String formalName() default Constants.NO_STRING_VALUE; 073 074 /** 075 * Get the documentary description of the field. 076 * <p> 077 * If the value is "##none", then the description will be considered 078 * {@code null}. 079 * 080 * @return a markdown string or {@code "##none"} if no description is provided 081 */ 082 @NonNull 083 String description() default Constants.NO_STRING_VALUE; 084 085 /** 086 * The model name to use for JSON/YAML singleton values and associated XML 087 * elements. 088 * <p> 089 * If the value is "##none", then the use name will be provided by the 090 * definition or by the field name if the item value class is missing the 091 * {@link MetaschemaField} annotation. 092 * 093 * @return the name 094 */ 095 @NonNull 096 String useName() default Constants.NO_STRING_VALUE; 097 098 /** 099 * The namespace to use for associated XML elements. 100 * <p> 101 * If the value is "##default", then element name is derived from the namespace 102 * provided in the package-info. 103 * 104 * @return the namespace 105 */ 106 String namespace() default Constants.DEFAULT_STRING_VALUE; 107 108 /** 109 * If the data type allows it, determines if the field's value must be wrapped 110 * with an XML element. 111 * 112 * @return {@code true} if the field must be wrapped, or {@code false} otherwise 113 */ 114 boolean inXmlWrapped() default MetaschemaModelConstants.DEFAULT_FIELD_IN_XML_WRAPPED; 115 116 /** 117 * A non-negative number that indicates the minimum occurrence of the model 118 * instance. 119 * 120 * @return a non-negative number 121 */ 122 int minOccurs() default MetaschemaModelConstants.DEFAULT_GROUP_AS_MIN_OCCURS; 123 124 /** 125 * A number that indicates the maximum occurrence of the model instance. 126 * 127 * @return a positive number or {@code -1} to indicate "unbounded" 128 */ 129 int maxOccurs() default MetaschemaModelConstants.DEFAULT_GROUP_AS_MAX_OCCURS; 130 131 /** 132 * Get any remarks for this field. 133 * 134 * @return a markdown string or {@code "##none"} if no remarks are provided 135 */ 136 @NonNull 137 String remarks() default Constants.NO_STRING_VALUE; 138}