com.basistech.rosette.RosetteConfigurationProperty Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of common-api Show documentation

Common Java API classes for Rosette

There is a newer version: 38.0.3

/*
* Copyright 2017 Basis Technology Corp.
*
* 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 com.basistech.rosette;

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

@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.FIELD})
/**
 * This annotation marks factory configuration options that should be included in configuration
 * files in an on-premise deployment.
 */
public @interface RosetteConfigurationProperty {

    /**
     * Indicates what this option is used to configure: factories, annotators, or both.
     */
    RosetteConfigurationType type();

    /**
     * The default value of the configuration option as a yaml string.
     */
    String defaultValue();

    /**
     * A comment describing the configuration option and how use it.
     */
    String comment();
}