• Home
• io.inverno.mod
• inverno-configuration
• 1.7.1
• source code
• DefaultableConfigurationSource.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

io.inverno.mod.configuration.DefaultableConfigurationSource Maven / Gradle / Ivy

/*
 * Copyright 2022 Jeremy KUHN
 *
 * 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 io.inverno.mod.configuration;

/**
 * 

 * A defaultable configuration source has the ability to search for default properties if no exact result exist for a given query.
 * 
 * 
 * 

 * Such source relies on {@code DefaultingStrategy} to obtain the list of queries to execute from the original query (see
 * {@link DefaultingStrategy#getDefaultingKeys(io.inverno.mod.configuration.ConfigurationKey)}).
 * 
 * 
 * @author Jeremy Kuhn
 * @since 1.5
 * 
 * @see DefaultingStrategy
 * 
 * @param  source specific query type
 * @param  source specific executable query type
 * @param  source specific list query type
 * @param  defaulting strategy type
 */
public interface DefaultableConfigurationSource, B extends ExecutableConfigurationQuery, C extends ListConfigurationQuery, D extends DefaultableConfigurationSource> extends ConfigurationSource {
	
	/**
	 * 

	 * Returns a proxy of the defaultable configuration source instance using the specified defaulting strategy.
	 * 
	 * 
	 * @param defaultingStrategy a defaulting strategy
	 * 
	 * @return a new defaultable configuration source
	 */
	D withDefaultingStrategy(DefaultingStrategy defaultingStrategy);
	
	/**
	 * 

	 * Returns the original configuration source.
	 * 
	 * 
	 * @return a configuration source
	 */
	D unwrap();
}