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.info;
028
029import java.util.Collection;
030import java.util.List;
031import java.util.Map;
032
033import edu.umd.cs.findbugs.annotations.NonNull;
034
035/**
036 * The class is used to "collect" items together to assign to the property's
037 * field. For fields with a collection type, implementations of this class will
038 * handle managing the underlying collection.
039 */
040public interface IPropertyCollector {
041  /**
042   * Add an item to the "collection", who's type depends on the property
043   * configuration.
044   *
045   * @param item
046   *          the item to add
047   * @throws IllegalStateException
048   *           if the item cannot be added due to a model inconsistency
049   */
050  void add(@NonNull Object item);
051
052  /**
053   * Add a collection of item to the "collection", who's type depends on the
054   * property configuration.
055   *
056   * @param items
057   *          the items to add
058   * @throws IllegalStateException
059   *           if the item cannot be added due to a model inconsistency
060   */
061  void addAll(@NonNull Collection<?> items);
062
063  /**
064   * Get the current state of the "collection". For single valued
065   * "non-collections" this may return a {@code null} value. For any collection
066   * type, such as {@link List} or {@link Map}, this must return a
067   * non-{@code null} empty collection.
068   *
069   * @return the "collection" value or {@code null} for a single valued instance
070   *         that is not defined
071   */
072  Object getValue();
073}