blob: 64853c513b7eda5719b7f3d6e31431fbd2026d91 [file] [log] [blame]
/*
* 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;
/**
* Models a function that maps a given {@link org.apache.tamaya.Configuration} to another {@link org.apache.tamaya.Configuration}. This can be used
* to model additional functionality and applying it to a given {@link org.apache.tamaya.Configuration} instance by calling
* the {@link org.apache.tamaya.Configuration#with(org.apache.tamaya.ConfigOperator)} method.
* @deprecated Use {@link java.util.function.UnaryOperator}
*/
@FunctionalInterface
@Deprecated
public interface ConfigOperator {
/**
* Creates a new {@link org.apache.tamaya.Configuration} based on the given Configuration. Operators basically act similar to
* decorators, whereas operated instances may have non-compatible behaviour, e.g. by applying security constraints
* or view restrictions.
*
* @param config the input configuration, not {@code null}.
* @return the operated configuration, never {@code null}.
*/
Configuration operate(Configuration config);
}