IMutableConfiguration.java
/*
* Portions of this software was developed by employees of the National Institute
* of Standards and Technology (NIST), an agency of the Federal Government and is
* being made available as a public service. Pursuant to title 17 United States
* Code Section 105, works of NIST employees are not subject to copyright
* protection in the United States. This software may be subject to foreign
* copyright. Permission in the United States and in foreign countries, to the
* extent that NIST may hold copyright, to use, copy, modify, create derivative
* works, and distribute this software and its documentation without fee is hereby
* granted on a non-exclusive basis, provided that this notice and disclaimer
* of warranty appears in all copies.
*
* THE SOFTWARE IS PROVIDED 'AS IS' WITHOUT ANY WARRANTY OF ANY KIND, EITHER
* EXPRESSED, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY
* THAT THE SOFTWARE WILL CONFORM TO SPECIFICATIONS, ANY IMPLIED WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND FREEDOM FROM
* INFRINGEMENT, AND ANY WARRANTY THAT THE DOCUMENTATION WILL CONFORM TO THE
* SOFTWARE, OR ANY WARRANTY THAT THE SOFTWARE WILL BE ERROR FREE. IN NO EVENT
* SHALL NIST BE LIABLE FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO, DIRECT,
* INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES, ARISING OUT OF, RESULTING FROM,
* OR IN ANY WAY CONNECTED WITH THIS SOFTWARE, WHETHER OR NOT BASED UPON WARRANTY,
* CONTRACT, TORT, OR OTHERWISE, WHETHER OR NOT INJURY WAS SUSTAINED BY PERSONS OR
* PROPERTY OR OTHERWISE, AND WHETHER OR NOT LOSS WAS SUSTAINED FROM, OR AROSE OUT
* OF THE RESULTS OF, OR USE OF, THE SOFTWARE OR SERVICES PROVIDED HEREUNDER.
*/
package gov.nist.secauto.metaschema.core.configuration;
import edu.umd.cs.findbugs.annotations.NonNull;
/**
* This interface provides methods for retrieving and updating the configuration
* of processors and parsers in this library. This provides a mutable view of
* the current configuration.
*
* @param <T>
* the type of the feature set
*/
public interface IMutableConfiguration<T extends IConfigurationFeature<?>>
extends IConfiguration<T> {
/**
* Turn on the provided feature.
*
* @param feature
* the feature to turn on
* @return the updated configuration
* @throws UnsupportedOperationException
* if the feature is not a boolean valued feature
* @see IConfigurationFeature#getValueClass()
*/
@NonNull
default IMutableConfiguration<T> enableFeature(@NonNull T feature) {
return set(feature, true);
}
/**
* Turn off the provided feature.
*
* @param feature
* the feature to turn off
* @return the updated configuration
* @throws UnsupportedOperationException
* if the feature is not a boolean valued feature
* @see IConfigurationFeature#getValueClass()
*/
@NonNull
default IMutableConfiguration<T> disableFeature(@NonNull T feature) {
return set(feature, false);
}
/**
* Replace this configuration with the {@code other} configuration.
*
* @param other
* the new configuration
* @return the updated configuration
*/
@NonNull
IMutableConfiguration<T> applyConfiguration(@NonNull IConfiguration<T> other);
/**
* Set the value of the provided {@code feature} to the provided value.
*
* @param feature
* the feature to set
* @param value
* the value to set
* @return the updated configuration
* @throws UnsupportedOperationException
* if the provided feature value is not assignment compatible with the
* features value type
* @see IConfigurationFeature#getValueClass()
*/
@NonNull
IMutableConfiguration<T> set(@NonNull T feature, @NonNull Object value);
}