t3.plugin.annotations.Parameter Maven / Gradle / Ivy

Go to download

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

Utility classes for T³ projects

The newest version!

/**
 * (C) Copyright 2016-2019 teecube
 * (https://teecu.be) and others.
 *
 * 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 t3.plugin.annotations;

import java.lang.annotation.*;

/**
 * 
 * This annotation is a clone of the
 * {@link org.apache.maven.plugins.annotations.Parameter} annotation but with
 * a RUNTIME retention policy.
 * 
 * 
 * The RUNTIME retention policy allows to read the annotation parameters
 * at run-time and to inject properly the default values for builtin properties
 * in the Maven model.
 * 
 * 
 * This clone is also enhanced with additional fields which will be removed from
 * original {@link org.apache.maven.plugins.annotations.Parameter}.
 * 
 *
 * @author Mathieu Debove <[email protected]>
 *
 */
@Retention( RetentionPolicy.RUNTIME ) // RUNTIME retention policy
@Target( { ElementType.FIELD } )
@Inherited
public @interface Parameter
{
    String alias() default "";

    String property();

    String defaultValue();

    boolean required() default false;

    boolean readonly() default false;

    // additional fields
    String description() default "";
    String[] requiredForPackagings() default "";
    boolean hideDocumentation() default false;
}