org.snakeyaml.engine.v2.env.EnvConfig Maven / Gradle / Ivy
/**
* Copyright (c) 2018, http://www.snakeyaml.org
*
* Licensed 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.snakeyaml.engine.v2.env;
import java.util.Optional;
/**
* Configurator for ENV format
*
* @see Variable substitution
*/
public interface EnvConfig {
/**
* Implement deviation from the standard logic.
* TODO implement wiki page
*
* @param name - variable name in the template
* @param separator - separator in the template, can be :-, -, :?, ? or null if not present
* @param value - default value or the error in the template or empty if not present
* @param environment - the value from environment for the provided variable or null if unset
* @return the value to apply in the template or empty to follow the standard logic
*/
default Optional getValueFor(String name, String separator, String value, String environment) {
return Optional.empty();
}
}