grails.config.Config.groovy Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of grails-core Show documentation

Grails Web Application Framework

There is a newer version: 6.2.0


/*
 * Copyright 2014 original authors
 *
 * 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 grails.config

import org.springframework.core.env.PropertyResolver

/**
 * Interface to application configuration
 *
 * @author Graeme Rocher
 * @since 3.0
 */
public interface Config extends PropertyResolver, ConfigMap {

    /**
     * @return The flat version of the config
     */
    @Deprecated
    Map flatten()

    /**
     * Converts the config to properties
     *
     * @return The properties
     */
    Properties toProperties()

    /**
     * Merge another config and return this config
     * @param toMerge The map to merge
     * @return This config
     */
    Config merge(Map toMerge)

    /**
     * Return the property value associated with the given key, or
     * {@code defaultValue} if the key cannot be resolved.
     * @param key the property name to resolve
     * @param targetType the expected type of the property value
     * @param defaultValue the default value to return if no value is found
     * @param the allowable values
     *
     * @see #getRequiredProperty(String, Class)
     */
    public  T getProperty(String key, Class targetType, T defaultValue, List allowedValues);
}