api / org.gradle.api.tasks.options / OptionValues

OptionValues

@Target([AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY_GETTER, AnnotationTarget.PROPERTY_SETTER]) @Inherited @Incubating class OptionValues

Marks a method on a org.gradle.api.Task as providing the possible values for a String or List<String> Option. At most one option values method may be provided for a particular option.

This annotation should be attached to a getter method that returns a java.util.Collection of possible values. The entries in the collection may be of any type. If necessary, they are transformed into String by calling toString().

Since
4.6

Constructors

<init>

OptionValues(vararg value: String)

Marks a method on a org.gradle.api.Task as providing the possible values for a String or List&lt;String&gt; Option. At most one option values method may be provided for a particular option.

This annotation should be attached to a getter method that returns a java.util.Collection of possible values. The entries in the collection may be of any type. If necessary, they are transformed into String by calling toString().

Properties

value

val value: Array<String>

The names of the options for which the method provides the possible values.