org.gradle.api.tasks.options.Option Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gradle-api Show documentation
Gradle 6.9.1 API redistribution.
There is a newer version: 8.11.1
/*
 * Copyright 2017 the original author or 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 org.gradle.api.tasks.options;

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

/**
 * Marks a property of a {@link org.gradle.api.Task} as being configurable from the command-line.
 *
 * This annotation should be attached to a field or a setter method. When attached to a field, {@link #option()}
 * will use the name of the field by default. When attached to a method, {@link #option()} must be specified.
 *
 * An option may have one of the following types:
 * 
 * {@code boolean}, {@code Boolean}, or {@code Property}
 * {@code Double} or {@code Property}
 * {@code Integer} or {@code Property}
 * {@code Long} or {@code Property}
 * {@code String} or {@code Property}
 * an {@code enum} type or {@code Property} of an enum type
 * {@code List} of type {@code Double}, {@code Integer}, {@code Long}, {@code String}, or an {@code enum} type
 * {@code ListProperty} and {@code SetProperty} of same type as {@code List}
 * {@code DirectoryProperty} or {@code RegularFileProperty}
 * 
 *
 * 
 * Note: Multiple {@code @Option}s with the same names are disallowed on different methods/fields.
 * Methods with the same signature (i.e. the same name, return type, and parameter types) are allowed to use
 * equal or unequal option names.
 * 
 * 
 * When the option names are equal, the description and method linked to the option will be the one in the
 * base class (if present), followed by super-classes, and finally interfaces, in an unspecified order.
 * 
 * 
 * When the option names are unequal, the order described above is used when setting the option's value.
 * If the base class has an option with the name "foo" and an interface has an option with the name "bar",
 * the option "foo" will have precedence over the option "bar" and setting both will result in the value of "foo".
 * 
 * 
 * 
 *     Depending on this behavior is discouraged. It is only in place to allow legacy migration to interface options.
 * 
 * 
 *
 * @since 4.6
 */
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD, ElementType.FIELD})
@Inherited
public @interface Option {

    /**
     * The option to map to this property. Required when annotating a method. May be omitted when annotating a field
     * in which case the field's name will be used.
     *
     * @return The option.
     */
    String option() default "";

    /**
     * The description of this option.
     *
     * @return The description.
     */
    String description();
}