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.TYPE; 030import static java.lang.annotation.RetentionPolicy.RUNTIME; 031 032import gov.nist.secauto.metaschema.core.model.IModule; 033import gov.nist.secauto.metaschema.core.model.MetaschemaModelConstants; 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 * This annotation indicates that the target class represents a Module field. 043 * <p> 044 * Classes with this annotation must have a field with the 045 * {@link MetaschemaFieldValue} annotation. 046 */ 047@Documented 048@Retention(RUNTIME) 049@Target(TYPE) 050public @interface MetaschemaField { 051 /** 052 * Get the documentary formal name of the field. 053 * <p> 054 * If the value is "##none", then the description will be considered 055 * {@code null}. 056 * 057 * @return a markdown string or {@code "##none"} if no formal name is provided 058 */ 059 @NonNull 060 String formalName() default Constants.NO_STRING_VALUE; 061 062 /** 063 * Get the documentary description of the field. 064 * <p> 065 * If the value is "##none", then the description will be considered 066 * {@code null}. 067 * 068 * @return a markdown string or {@code "##none"} if no description is provided 069 */ 070 @NonNull 071 String description() default Constants.NO_STRING_VALUE; 072 073 /** 074 * Name of the field. 075 * 076 * @return the name 077 */ 078 @NonNull 079 String name(); 080 081 @NonNull 082 String useName() default Constants.NO_STRING_VALUE; 083 084 /** 085 * Get the metaschema class that "owns" this assembly, which is the concrete 086 * implementation of the metaschema containing the assembly. 087 * 088 * @return the class that extends {@link IModule} 089 */ 090 Class<? extends IModule> moduleClass(); 091 092 /** 093 * If the data type allows it, determines if the field's value must be wrapped 094 * with an XML element whose name is the specified {@link #name()} and namespace 095 * is derived from the namespace of the instance. 096 * 097 * @return {@code true} if the field must be wrapped, or {@code false} otherwise 098 */ 099 boolean inXmlWrapped() default MetaschemaModelConstants.DEFAULT_FIELD_IN_XML_WRAPPED; 100 101 /** 102 * Get any remarks for this field. 103 * 104 * @return a markdown string or {@code "##none"} if no remarks are provided 105 */ 106 @NonNull 107 String remarks() default Constants.NO_STRING_VALUE; 108}