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 java.util.Collection; 032 033import edu.umd.cs.findbugs.annotations.NonNull; 034 035public interface INamedModelInstance extends INamedInstance, IModelInstance { 036 @Override 037 @NonNull 038 IFlagContainer getDefinition(); 039 040 @Override 041 default String getJsonName() { 042 @NonNull String retval; 043 if (getMaxOccurs() == -1 || getMaxOccurs() > 1) { 044 @NonNull String groupAsName = ObjectUtils.requireNonNull(getGroupAsName(), 045 ObjectUtils.notNull(String.format("null group-as name in instance '%s' on definition '%s' in '%s'", 046 this.getName(), 047 this.getContainingDefinition().getName(), 048 this.getContainingModule().getLocation()))); 049 retval = groupAsName; 050 } else { 051 retval = getEffectiveName(); 052 } 053 return retval; 054 } 055 056 /** 057 * Get the item values for the provided {@code instanceValue}. An instance may 058 * be singular or many valued. 059 * 060 * @param instanceValue 061 * the instance 062 * @return the item values or an empty collection if no item values exist 063 */ 064 @NonNull 065 Collection<?> getItemValues(Object instanceValue); 066}