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 edu.umd.cs.findbugs.annotations.NonNull;
030
031/**
032 * This interface provides methods for retrieving and updating the configuration
033 * of processors and parsers in this library. This provides a mutable view of
034 * the current configuration.
035 *
036 * @param <T>
037 *          the type of the feature set
038 */
039public interface IMutableConfiguration<T extends IConfigurationFeature<?>>
040    extends IConfiguration<T> {
041  /**
042   * Turn on the provided feature.
043   *
044   * @param feature
045   *          the feature to turn on
046   * @return the updated configuration
047   * @throws UnsupportedOperationException
048   *           if the feature is not a boolean valued feature
049   * @see IConfigurationFeature#getValueClass()
050   */
051  @NonNull
052  default IMutableConfiguration<T> enableFeature(@NonNull T feature) {
053    return set(feature, true);
054  }
055
056  /**
057   * Turn off the provided feature.
058   *
059   * @param feature
060   *          the feature to turn off
061   * @return the updated configuration
062   * @throws UnsupportedOperationException
063   *           if the feature is not a boolean valued feature
064   * @see IConfigurationFeature#getValueClass()
065   */
066  @NonNull
067  default IMutableConfiguration<T> disableFeature(@NonNull T feature) {
068    return set(feature, false);
069  }
070
071  /**
072   * Replace this configuration with the {@code other} configuration.
073   *
074   * @param other
075   *          the new configuration
076   * @return the updated configuration
077   */
078  @NonNull
079  IMutableConfiguration<T> applyConfiguration(@NonNull IConfiguration<T> other);
080
081  /**
082   * Set the value of the provided {@code feature} to the provided value.
083   *
084   * @param feature
085   *          the feature to set
086   * @param value
087   *          the value to set
088   * @return the updated configuration
089   * @throws UnsupportedOperationException
090   *           if the provided feature value is not assignment compatible with the
091   *           features value type
092   * @see IConfigurationFeature#getValueClass()
093   */
094  @NonNull
095  IMutableConfiguration<T> set(@NonNull T feature, @NonNull Object value);
096}