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.core.model;
028
029import gov.nist.secauto.metaschema.core.util.ObjectUtils;
030
031import javax.xml.namespace.QName;
032
033import edu.umd.cs.findbugs.annotations.NonNull;
034
035public interface IFlagInstance extends INamedInstance, IFlag {
036
037  @Override
038  IFlagContainer getParentContainer();
039
040  @Override
041  default String getXmlNamespace() {
042    // by default, flags do not have namespaces
043    return null;
044  }
045
046  @NonNull
047  @Override
048  default QName getXmlQName() {
049    // flags always have a qname
050    return ObjectUtils.requireNonNull(INamedInstance.super.getXmlQName());
051  }
052
053  @Override
054  IFlagDefinition getDefinition();
055
056  /**
057   * Determines if a flag value is required to be provided.
058   *
059   * @return {@code true} if a value is required, or {@code false} otherwise
060   */
061  boolean isRequired();
062
063  /**
064   * Determines if this flag's value is used as the property name for the JSON
065   * object that holds the remaining data based on this flag's containing
066   * definition.
067   *
068   * @return {@code true} if this flag is used as a JSON key, or {@code false}
069   *         otherwise
070   */
071  default boolean isJsonKey() {
072    IFlagInstance flagInstance = getContainingDefinition().getJsonKeyFlagInstance();
073    return this.equals(flagInstance);
074  }
075
076  /**
077   * Determines if this flag is used as a JSON "value key". A "value key" is a
078   * flag who's value is used as the property name for the containing objects
079   * value.
080   *
081   * @return {@code true} if the flag is used as a JSON "value key", or
082   *         {@code false} otherwise
083   */
084  default boolean isJsonValueKey() {
085    IFlagContainer containingDefinition = getContainingDefinition();
086    return containingDefinition instanceof IFieldDefinition
087        && this.equals(((IFieldDefinition) containingDefinition).getJsonValueKeyFlagInstance());
088  }
089}