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 java.util.Collection; 030 031import edu.umd.cs.findbugs.annotations.NonNull; 032import edu.umd.cs.findbugs.annotations.Nullable; 033 034/** 035 * This marker interface identifies a type of definition that contains flags, 036 * either a field or assembly. 037 */ 038public interface IFlagContainer extends IDefinition, IContainer { 039 /** 040 * Retrieve the Metaschema definition containing this container. 041 * 042 * @return the containing Metaschema definition 043 */ 044 @Override 045 @NonNull 046 IFlagContainer getOwningDefinition(); 047 048 @Override 049 INamedModelInstance getInlineInstance(); 050 051 /** 052 * Identifies if the field has flags or not, or if it has a complex structure 053 * (i.e, model). 054 * 055 * @return {@code true} if the field has no flags or model, or false otherwise 056 */ 057 default boolean isSimple() { 058 return getFlagInstances().isEmpty(); 059 } 060 061 /** 062 * Retrieves a flag instance, by the flag's effective name, that is defined on 063 * the containing definition. 064 * 065 * @param name 066 * the flag's name 067 * @return the matching flag instance, or {@code null} if there is no flag 068 * matching the specified name 069 */ 070 @Nullable 071 IFlagInstance getFlagInstanceByName(@NonNull String name); 072 073 /** 074 * Retrieves the flag instances for all flags defined on the containing 075 * definition. 076 * 077 * @return the flags 078 */ 079 @NonNull 080 Collection<? extends IFlagInstance> getFlagInstances(); 081 082 /** 083 * Indicates if a flag's value can be used as a property name in the containing 084 * object in JSON who's value will be the object containing the flag. In such 085 * cases, the flag will not appear in the object. This is only allowed if the 086 * flag is required, as determined by a {@code true} result from 087 * {@link IFlagInstance#isRequired()}. The {@link IFlagInstance} can be 088 * retrieved using {@link #getJsonKeyFlagInstance()}. 089 * 090 * @return {@code true} if the flag's value can be used as a property name, or 091 * {@code false} otherwise 092 * @see #getJsonKeyFlagInstance() 093 */ 094 // TODO: remove once moved to the instance side 095 default boolean hasJsonKey() { 096 return getJsonKeyFlagInstance() != null; 097 } 098 099 /** 100 * Retrieves the flag instance to use as as the property name for the containing 101 * object in JSON who's value will be the object containing the flag. 102 * 103 * @return the flag instance if a JSON key is configured, or {@code null} 104 * otherwise 105 * @see #hasJsonKey() 106 */ 107 // TODO: remove once moved to the instance side 108 @Nullable 109 IFlagInstance getJsonKeyFlagInstance(); 110}