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.JsonGroupAsBehavior;
033import gov.nist.secauto.metaschema.core.model.XmlGroupAsBehavior;
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@Documented
042@Retention(RUNTIME)
043@Target({ FIELD })
044public @interface GroupAs {
045  /**
046   * The name to use for an XML grouping element wrapper or a JSON/YAML grouping
047   * property.
048   *
049   * @return the name
050   */
051  @NonNull
052  String name();
053
054  /**
055   * XML target namespace of the XML grouping element.
056   * <p>
057   * If the value is "##default", then element name is derived from the namespace
058   * provided in the package-info.
059   *
060   * @return the namespace
061   */
062  @NonNull
063  String namespace() default Constants.DEFAULT_STRING_VALUE;
064
065  /**
066   * Describes how to handle collections in JSON/YAML.
067   *
068   * @return the JSON collection strategy
069   */
070  @NonNull
071  JsonGroupAsBehavior inJson() default JsonGroupAsBehavior.SINGLETON_OR_LIST;
072
073  /**
074   * Describes how to handle collections in XML.
075   *
076   * @return the XML collection strategy
077   */
078  @NonNull
079  XmlGroupAsBehavior inXml() default XmlGroupAsBehavior.UNGROUPED;
080}