colesico.framework.config.UseSource Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of colesico-config Show documentation

Colesico framework configuration support module

There is a newer version: 5.3.0

/*
 * Copyright © 2014-2020 Vladlen V. Larionov and others as noted.
 *
 * 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 colesico.framework.config;

import java.lang.annotation.*;

/**
 * Configuration source usage definition for configuration bean.
 * 
 * Configuration source contains a configuration values.
 * For example it can be a .properties file or a .yaml file or even sql data base,
 * or remote json resource accessible by http
 * 

 *
 * @author Vladlen Larionov
 * @see FromSource
 * @see ConfigSource
 * @see Config
 * 
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@Inherited
@Documented
public @interface UseSource {

    /**
     * Config source type. PropertiesSource supported out-of the-box.
     *
     * @see PropertiesSource
     */
    Class type() default ConfigSource.class;

    /**
     * Assumes that values for all fields are assigned from config source.
     * If false - the  @{@link FromSource} annotation should be used to assign the value to field.
     *
     * @see FromSource
     * @see NotFromSource
     */
    boolean bindAll() default true;
}