org.gradle.api.internal.plugins

Class DefaultConvention

java.lang.Object

org.gradle.api.internal.plugins.DefaultConvention

All Implemented Interfaces:

Convention, ExtensionContainer

public class DefaultConvention
extends Object
implements Convention

Author:

Hans Dockter

Constructor Summary

Constructors

Constructor and Description
DefaultConvention() This method should be used in runtime code proper as means that the convention cannot create dynamic extensions.
DefaultConvention(Instantiator instantiator)

Method Summary

Methods

Modifier and Type	Method and Description
void	add(String name, Class<?> type, Object... constructionArguments) Deprecated.
void	add(String name, Object extension) Adding an extension of name 'foo' will: add 'foo' dynamic property add 'foo' dynamic method that accepts a closure that is a configuration script block
<T> T	create(String name, Class<T> type, Object... constructionArguments) Adds a new extension to this container, that itself is dynamically made ExtensionAware.
Object	findByName(String name) Looks for the extension of a given name.
<T> T	findByType(Class<T> type) Looks for the extension of a given type (useful to avoid casting).
<T> T	findPlugin(Class<T> type) Locates the plugin convention object with the given type.
Object	getByName(String name) Looks for the extension of a given name.
<T> T	getByType(Class<T> type) Looks for the extension of a given type (useful to avoid casting).
DynamicObject	getExtensionsAsDynamicObject() Returns a dynamic object which represents the properties and methods contributed by the extensions and convention objects contained in this convention.
ExtraPropertiesExtension	getExtraProperties() The extra properties extension in this extension container.
<T> T	getPlugin(Class<T> type) Locates the plugin convention object with the given type.
Map<String,Object>	getPlugins() Returns the plugin convention objects contained in this convention.
Object	propertyMissing(String name)
void	propertyMissing(String name, Object value)

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultConvention

public DefaultConvention()

This method should be used in runtime code proper as means that the convention cannot create dynamic extensions. It's here for backwards compatibility with our tests and for convenience.

See Also:

DefaultConvention(org.gradle.api.internal.Instantiator)

DefaultConvention

public DefaultConvention(Instantiator instantiator)

Method Detail

getPlugins

public Map<String,Object> getPlugins()

Description copied from interface: Convention

Returns the plugin convention objects contained in this convention.

Specified by:

getPlugins in interface Convention

Returns:

The plugins. Returns an empty map when this convention does not contain any convention objects.

getExtensionsAsDynamicObject

public DynamicObject getExtensionsAsDynamicObject()

Description copied from interface: Convention

Returns a dynamic object which represents the properties and methods contributed by the extensions and convention objects contained in this convention.

Specified by:

getExtensionsAsDynamicObject in interface Convention

Returns:

The dynamic object

getPlugin

public <T> T getPlugin(Class<T> type)

Description copied from interface: Convention

Locates the plugin convention object with the given type.

Specified by:

getPlugin in interface Convention

Parameters:

type - The convention object type.

Returns:

The object. Never returns null.

findPlugin

public <T> T findPlugin(Class<T> type)
             throws IllegalStateException

Description copied from interface: Convention

Locates the plugin convention object with the given type.

Specified by:

findPlugin in interface Convention

Parameters:

type - The convention object type.

Returns:

The object. Returns null if there is no such object.

Throws:

IllegalStateException - When there there are multiple matching objects.

add

public void add(String name,
       Object extension)

Description copied from interface: ExtensionContainer

Adding an extension of name 'foo' will:

add 'foo' dynamic property add 'foo' dynamic method that accepts a closure that is a configuration script block

Specified by:

add in interface ExtensionContainer

Parameters:

name - Will be used as a sort of namespace of properties/methods.

extension - Any object whose methods and properties will extend the target object

add

public void add(String name,
       Class<?> type,
       Object... constructionArguments)

Description copied from interface: ExtensionContainer

Deprecated. Use ExtensionContainer.create(java.lang.String, java.lang.Class<T>, java.lang.Object...)

Specified by:

add in interface ExtensionContainer

Parameters:

name - The name for the extension

type - The type of the extension

constructionArguments - The arguments to be used to construct the extension instance

create

public <T> T create(String name,
           Class<T> type,
           Object... constructionArguments)

Description copied from interface: ExtensionContainer

Adds a new extension to this container, that itself is dynamically made ExtensionAware. A new instance of the given type will be created using the given constructionArguments. The new instance will have been dynamically which means that you can cast the object to ExtensionAware.

Specified by:

create in interface ExtensionContainer

Parameters:

name - The name for the extension

type - The type of the extension

constructionArguments - The arguments to be used to construct the extension instance

Returns:

The created instance

See Also:

ExtensionContainer.add(String, Object)

getExtraProperties

public ExtraPropertiesExtension getExtraProperties()

Description copied from interface: ExtensionContainer

The extra properties extension in this extension container. This extension is always present in the container, with the name ?ext?.

Specified by:

getExtraProperties in interface ExtensionContainer

Returns:

The extra properties extension in this extension container.

getByType

public <T> T getByType(Class<T> type)

Description copied from interface: ExtensionContainer

Looks for the extension of a given type (useful to avoid casting). If none found it will throw an exception.

Specified by:

getByType in interface ExtensionContainer

Parameters:

type - extension type

Returns:

extension, never null

findByType

public <T> T findByType(Class<T> type)

Description copied from interface: ExtensionContainer

Looks for the extension of a given type (useful to avoid casting). If none found null is returned.

Specified by:

findByType in interface ExtensionContainer

Parameters:

type - extension type

Returns:

extension or null

getByName

public Object getByName(String name)

Description copied from interface: ExtensionContainer

Looks for the extension of a given name. If none found it will throw an exception.

Specified by:

getByName in interface ExtensionContainer

Parameters:

name - extension name

Returns:

extension, never null

findByName

public Object findByName(String name)

Description copied from interface: ExtensionContainer

Looks for the extension of a given name. If none found null is returned.

Specified by:

findByName in interface ExtensionContainer

Parameters:

name - extension name

Returns:

extension or null

propertyMissing

public Object propertyMissing(String name)

propertyMissing

public void propertyMissing(String name,
                   Object value)