1 /* 2 * Portions of this software was developed by employees of the National Institute 3 * of Standards and Technology (NIST), an agency of the Federal Government and is 4 * being made available as a public service. Pursuant to title 17 United States 5 * Code Section 105, works of NIST employees are not subject to copyright 6 * protection in the United States. This software may be subject to foreign 7 * copyright. Permission in the United States and in foreign countries, to the 8 * extent that NIST may hold copyright, to use, copy, modify, create derivative 9 * works, and distribute this software and its documentation without fee is hereby 10 * granted on a non-exclusive basis, provided that this notice and disclaimer 11 * of warranty appears in all copies. 12 * 13 * THE SOFTWARE IS PROVIDED 'AS IS' WITHOUT ANY WARRANTY OF ANY KIND, EITHER 14 * EXPRESSED, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY 15 * THAT THE SOFTWARE WILL CONFORM TO SPECIFICATIONS, ANY IMPLIED WARRANTIES OF 16 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND FREEDOM FROM 17 * INFRINGEMENT, AND ANY WARRANTY THAT THE DOCUMENTATION WILL CONFORM TO THE 18 * SOFTWARE, OR ANY WARRANTY THAT THE SOFTWARE WILL BE ERROR FREE. IN NO EVENT 19 * SHALL NIST BE LIABLE FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO, DIRECT, 20 * INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES, ARISING OUT OF, RESULTING FROM, 21 * OR IN ANY WAY CONNECTED WITH THIS SOFTWARE, WHETHER OR NOT BASED UPON WARRANTY, 22 * CONTRACT, TORT, OR OTHERWISE, WHETHER OR NOT INJURY WAS SUSTAINED BY PERSONS OR 23 * PROPERTY OR OTHERWISE, AND WHETHER OR NOT LOSS WAS SUSTAINED FROM, OR AROSE OUT 24 * OF THE RESULTS OF, OR USE OF, THE SOFTWARE OR SERVICES PROVIDED HEREUNDER. 25 */ 26 27 package gov.nist.secauto.metaschema.databind.model.info; 28 29 import java.util.Collection; 30 import java.util.List; 31 import java.util.Map; 32 33 import edu.umd.cs.findbugs.annotations.NonNull; 34 35 /** 36 * The class is used to "collect" items together to assign to the property's 37 * field. For fields with a collection type, implementations of this class will 38 * handle managing the underlying collection. 39 */ 40 public interface IPropertyCollector { 41 /** 42 * Add an item to the "collection", who's type depends on the property 43 * configuration. 44 * 45 * @param item 46 * the item to add 47 * @throws IllegalStateException 48 * if the item cannot be added due to a model inconsistency 49 */ 50 void add(@NonNull Object item); 51 52 /** 53 * Add a collection of item to the "collection", who's type depends on the 54 * property configuration. 55 * 56 * @param items 57 * the items to add 58 * @throws IllegalStateException 59 * if the item cannot be added due to a model inconsistency 60 */ 61 void addAll(@NonNull Collection<?> items); 62 63 /** 64 * Get the current state of the "collection". For single valued 65 * "non-collections" this may return a {@code null} value. For any collection 66 * type, such as {@link List} or {@link Map}, this must return a 67 * non-{@code null} empty collection. 68 * 69 * @return the "collection" value or {@code null} for a single valued instance 70 * that is not defined 71 */ 72 Object getValue(); 73 }