Annotation Type ReplacedBy


@Documented @Retention(RUNTIME) @Target({METHOD,FIELD}) public @interface ReplacedBy

Attached to a task property to indicate that the property has been replaced by another. Like Internal, the property is ignored during up-to-date checks.

This annotation should be attached to the getter method in Java or the property field in Groovy. In Kotlin, use the get: use-site target to attach it to the property getter, for example @get:ReplacedBy("newProperty"). This also works on abstract properties, where the annotation without a use-site target does not compile. You should also consider adding Deprecated to any replaced property.

This will cause the task not to be considered out-of-date when the property has changed.

Since:
5.4
  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    The Java Bean-style name of the replacement property.
  • Element Details

    • value

      String value
      The Java Bean-style name of the replacement property.

      If the property has been replaced with a method named getFooBar(), then this should be fooBar.

      Since:
      5.4