org.gradle.api.internal.plugins

Class DefaultExtraPropertiesExtension

java.lang.Object

groovy.lang.GroovyObjectSupport

org.gradle.api.internal.plugins.DefaultExtraPropertiesExtension

All Implemented Interfaces:

GroovyObject, ExtraPropertiesExtension

public class DefaultExtraPropertiesExtension
extends GroovyObjectSupport
implements ExtraPropertiesExtension

Nested Class Summary

Nested classes/interfaces inherited from interface org.gradle.api.plugins.ExtraPropertiesExtension

ExtraPropertiesExtension.UnknownPropertyException

Field Summary

Fields inherited from interface org.gradle.api.plugins.ExtraPropertiesExtension

EXTENSION_NAME

Constructor Summary

Constructors

Constructor and Description
DefaultExtraPropertiesExtension()

Method Summary

Methods

Modifier and Type	Method and Description
Object	get(String name) Returns the value for the registered property with the given name.
Map<String,Object>	getProperties() Returns all of the registered properties and their current values as a map.
Object	getProperty(String name)
boolean	has(String name) Returns whether or not the extension has a property registered via the given name.
Object	methodMissing(String name, Object args)
void	set(String name, Object value) Updates the value for, or creates, the registered property with the given name to the given value.
void	setProperty(String name, Object newValue)

Methods inherited from class groovy.lang.GroovyObjectSupport

getMetaClass, invokeMethod, setMetaClass

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultExtraPropertiesExtension

public DefaultExtraPropertiesExtension()

Method Detail

has

public boolean has(String name)

Description copied from interface: ExtraPropertiesExtension

Returns whether or not the extension has a property registered via the given name.

 assert project.ext.has("foo") == false
 assert project.hasProperty("foo") == false

 project.ext.foo = "bar"

 assert project.ext.has("foo")
 assert project.hasProperty("foo")
 

Specified by:

has in interface ExtraPropertiesExtension

Parameters:

name - The name of the property to check for

Returns:

true if a property has been registered with this name, otherwise false.

get

public Object get(String name)

Description copied from interface: ExtraPropertiesExtension

Returns the value for the registered property with the given name. When using an extra properties extension from Groovy, you can also get properties via Groovy's property syntax. All of the following lines of code are equivalent.

 project.ext { foo = "bar" }

 assert project.ext.get("foo") == "bar"
 assert project.ext.foo == "bar"
 assert project.ext["foo"] == "bar"

 assert project.foo == "bar"
 assert project["foo"] == "bar"
 

When using the first form, an ExtraPropertiesExtension.UnknownPropertyException exception will be thrown if the extension does not have a property called ?foo?. When using the second forms (i.e. Groovy notation), Groovy's MissingPropertyException will be thrown instead.

Specified by:

get in interface ExtraPropertiesExtension

Parameters:

name - The name of the property to get the value of

Returns:

The value for the property with the given name.

set

public void set(String name,
       Object value)

Description copied from interface: ExtraPropertiesExtension

Updates the value for, or creates, the registered property with the given name to the given value. When using an extra properties extension from Groovy, you can also set properties via Groovy's property syntax. All of the following lines of code are equivalent.

 project.ext.set("foo", "bar")
 project.ext.foo = "bar"
 project.ext["foo"] = "bar"

 // Once the property has been created via the extension, it can be changed by the owner.
 project.foo = "bar"
 project["foo"] = "bar"
 

Specified by:

set in interface ExtraPropertiesExtension

Parameters:

name - The name of the property to update the value of or create

value - The value to set for the property

getProperty

public Object getProperty(String name)

Specified by:

getProperty in interface GroovyObject

Overrides:

getProperty in class GroovyObjectSupport

setProperty

public void setProperty(String name,
               Object newValue)

Specified by:

setProperty in interface GroovyObject

Overrides:

setProperty in class GroovyObjectSupport

getProperties

public Map<String,Object> getProperties()

Description copied from interface: ExtraPropertiesExtension

Returns all of the registered properties and their current values as a map. The returned map is detached from the extension. That is, any changes made to the map do not change the extension from which it originated.

 project.version = "1.0"

 assert project.hasProperty("version")
 assert project.ext.properties.containsKey("version") == false

 project.ext.foo = "bar"

 assert project.ext.properties.containsKey("foo")
 assert project.ext.properties.foo == project.ext.foo

 assert project.ext.properties.every { key, value -> project.properties[key] == value }
 

Specified by:

getProperties in interface ExtraPropertiesExtension

Returns:

All of the registered properties and their current values as a map.

methodMissing

public Object methodMissing(String name,
                   Object args)