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.configuration;
028
029import java.util.Map;
030
031import edu.umd.cs.findbugs.annotations.NonNull;
032
033/**
034 * The base interface for getting the configuration of processors and parsers in
035 * this library. This provides an immutable view of the current configuration.
036 *
037 * @param <T>
038 *          the type of the feature set
039 */
040public interface IConfiguration<T extends IConfigurationFeature<?>> {
041  /**
042   * Determines if a specific feature is enabled.
043   *
044   * @param feature
045   *          the feature to check for
046   * @return {@code true} if the feature is enabled, or {@code false} otherwise
047   * @throws UnsupportedOperationException
048   *           if the feature is not a boolean valued feature
049   * @see IConfigurationFeature#getValueClass()
050   */
051  boolean isFeatureEnabled(@NonNull T feature);
052
053  /**
054   * Get the configuration value of the provided {@code feature}.
055   *
056   * @param <V>
057   *          the value type
058   * @param feature
059   *          the requested feature
060   * @return the value of the feature
061   */
062  @SuppressWarnings("unchecked")
063  @NonNull
064  default <V> V get(@NonNull T feature) {
065    V value = (V) getFeatureValues().get(feature);
066    if (value == null) {
067      value = (V) feature.getDefault();
068    }
069    return value;
070  }
071
072  /**
073   * Get the mapping of each feature mapped to its value.
074   *
075   * @return the mapping
076   */
077  @NonNull
078  Map<T, Object> getFeatureValues();
079}