code/api/src/main/java/org/apache/tamaya/spi/ChangeSupport.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package org.apache.tamaya.spi;

import java.util.function.BiConsumer;

/**
 * Enum type that describges the config change capabilities of a property source.
 */
@Experimental
public enum ChangeSupport {
    /**
     * Config change is supported, this config source supports registering ConfigChangeListeners.
     * {@link PropertySource#addChangeListener(BiConsumer)} .
     */
    SUPPORTED,
    /**
     * Config change is not supported. Configuration values may change, though changes are not reported.
     */
    UNSUPPORTED,
    /**
     * Configuration properties of this property source cannot change for the lifetime of this {@link PropertySource}.
     */
    IMMUTABLE
}