org.gradle.api.dsl
Class ConvenienceProperty

java.lang.Object
  org.gradle.api.dsl.ConvenienceProperty

public class ConvenienceProperty
extends Object

ConventionProperty can be assigned but cannot be mutated (even if the object is mutable!)

Understanding convention properties is important mostly for collections because one might want to mutate the collection but it wouldn't work.

Consider this example:

 someTask {
   //Convention properties cannot be mutated,
   //even if the object is mutable!
   conventionProperty.add('c')  //WRONG!

   //However, convention properties can be assigned:
   conventionProperty += 'c'  //OK
   conventionProperty = ['a', 'b']  //OK

   //Simple properties can be mutated or assigned:
   simpleProperty = ['1.5']  //OK
   simpleProperty.add('1.5')  //OK
 }
 

 apply plugin: 'java'

 test {
   //test task has a testClassesDir convention property
   //that is by default configured to 'test classes dir'
   //testClassesDir = sourceSets.test.classesDir
 }

 //what if someone reconfigured the 'test classes dir'
 //after the 'test' task was configured? Like that:
 sourceSets.test.classesDir = new File(buildDir, 'test-classes')

 //will the already-configured test.testClassesDir property
 //on a 'test' task point to a wrong folder?
 

Thanks to the 'lazy' evaluation of the convention properties the user can reconfigure the sourceSets anywhere in the gradle script - and still the test.testClassesDir will point to the right folder. Author: Szczepan Faber, created at: 4/19/11

ConvenienceProperty

public ConvenienceProperty()