Convention (Gradle API 0.9-rc-3)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.gradle.api.plugins
Interface Convention

All Superinterfaces:: org.gradle.api.internal.DynamicObject

public interface Convention
extends org.gradle.api.internal.DynamicObject
extends org.gradle.api.internal.DynamicObject

A Convention manages a set of convention objects. When you add a convention object to a Convention, and the properties and methods of the convention object become available as properties and methods of the object which the convention is associated to. A convention object is simply a POJO or POGO. Usually, a Convention is used by plugins to extend a Project or a Task.

Method Summary





<T> T

findPlugin(Class<T> type)
Locates the plugin convention object with the given type.





<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.

Methods inherited from interface org.gradle.api.internal.DynamicObject
`getProperties, getProperty, hasMethod, hasProperty, invokeMethod, setProperty`

Method Detail

getPlugins

Map<String,Object> getPlugins()

Returns the plugin convention objects contained in this convention.

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

getPlugin

<T> T getPlugin(Class<T> type)
            throws IllegalStateException

Locates the plugin convention object with the given type.

Parameters:: type - The convention object type.
Returns:: The object. Never returns null.
Throws:: IllegalStateException - When there is no such object contained in this convention, or when there are multiple such objects.

findPlugin

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