hu.icellmobilsoft.coffee.module.configdoc.DynamicConfigTemplate Maven / Gradle / Ivy

Go to download
/*-
 * #%L
 * Coffee
 * %%
 * Copyright (C) 2020 - 2022 i-Cell Mobilsoft Zrt.
 * %%
 * 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.
 * #L%
 */
package hu.icellmobilsoft.coffee.module.configdoc;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * Annotation used to mark template classes, interfaces for dynamic configs. Dynamic documentation template will be generated based on the annotated
 * configuration class or interface
 *
 * @author mark.petrenyi
 * @since 1.10.0
 */
@Documented
@Target({ ElementType.METHOD, ElementType.FIELD, ElementType.PARAMETER, ElementType.TYPE })
@Retention(RetentionPolicy.CLASS)
public @interface DynamicConfigTemplate {
    /**
     * Dynamic config template directory
     */
    String TEMPLATE_DIR = "META-INF/config-templates/";
    /**
     * Dynamic config template extension
     */
    String TEMPLATE_TYPE = ".adoc";
}