org.gradle.api.internal.plugins

Class DefaultProjectsPluginContainer

java.lang.Object

java.util.AbstractCollection<T>

org.gradle.api.internal.DefaultDomainObjectCollection<T>

org.gradle.api.internal.DefaultDomainObjectSet<T>

org.gradle.api.internal.plugins.DefaultPluginCollection<Plugin>

org.gradle.api.internal.plugins.DefaultProjectsPluginContainer

All Implemented Interfaces:

Iterable<Plugin>, Collection<Plugin>, Set<Plugin>, DomainObjectCollection<Plugin>, DomainObjectSet<Plugin>, PluginCollection<Plugin>, PluginContainer

public class DefaultProjectsPluginContainer
extends DefaultPluginCollection<Plugin>
implements PluginContainer

Author:

Hans Dockter

Constructor Summary

Constructors

Constructor and Description
DefaultProjectsPluginContainer(PluginRegistry pluginRegistry, Project project)

Method Summary

Methods

Modifier and Type	Method and Description
<T extends Plugin> T	apply(Class<T> type) Applies a plugin to the project.
Plugin	apply(String id) Has the same behavior as PluginContainer.apply(Class) except that the the plugin is specified via its id.
<T extends Plugin> T	findPlugin(Class<T> type) Returns the plugin for the given type.
Plugin	findPlugin(String id) Returns the plugin for the given id.
<T extends Plugin> T	getAt(Class<T> type) Returns a plugin with the specified type if this plugin has been used in the project.
Plugin	getAt(String id) Returns a plugin with the specified id if this plugin has been used in the project.
<T extends Plugin> T	getPlugin(Class<T> type) Returns a plugin with the specified type if this plugin has been used in the project.
Plugin	getPlugin(String id) Returns a plugin with the specified id if this plugin has been used in the project.
protected Class<? extends Plugin>	getTypeForId(String id)
boolean	hasPlugin(Class<? extends Plugin> type) Returns true if the container has a plugin with the given type, false otherwise.
boolean	hasPlugin(String id) Returns true if the container has a plugin with the given id, false otherwise.

Methods inherited from class org.gradle.api.internal.plugins.DefaultPluginCollection

filtered, matching, matching, whenPluginAdded, whenPluginAdded, withType

Methods inherited from class org.gradle.api.internal.DefaultDomainObjectSet

filteredStore, findAll

Methods inherited from class org.gradle.api.internal.DefaultDomainObjectCollection

add, addAll, all, all, assertMutable, beforeChange, clear, contains, containsAll, createFilter, createFilter, createFilter, filteredEvents, findAll, getEventRegister, getStore, getType, isEmpty, iterator, remove, removeAll, retainAll, size, whenObjectAdded, whenObjectAdded, whenObjectRemoved, whenObjectRemoved, withType, withType

Methods inherited from class java.util.AbstractCollection

toArray, toArray, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.gradle.api.plugins.PluginCollection

matching, matching, whenPluginAdded, whenPluginAdded, withType

Methods inherited from interface org.gradle.api.DomainObjectSet

findAll

Methods inherited from interface org.gradle.api.DomainObjectCollection

all, all, whenObjectAdded, whenObjectAdded, whenObjectRemoved, whenObjectRemoved, withType, withType

Methods inherited from interface java.util.Set

add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray

Constructor Detail

DefaultProjectsPluginContainer

public DefaultProjectsPluginContainer(PluginRegistry pluginRegistry,
                              Project project)

Method Detail

apply

public Plugin apply(String id)

Description copied from interface: PluginContainer

Has the same behavior as PluginContainer.apply(Class) except that the the plugin is specified via its id. Not all plugins have an id.

Specified by:

apply in interface PluginContainer

Parameters:

id - The id of the plugin to be applied.

Returns:

The plugin which has been used against the project.

apply

public <T extends Plugin> T apply(Class<T> type)

Description copied from interface: PluginContainer

Applies a plugin to the project. This usually means that the plugin uses the project API to add and modify the state of the project. This method can be called an arbitrary number of times for a particular plugin type. The plugin will be actually used only the first time this method is called.

Specified by:

apply in interface PluginContainer

Parameters:

type - The type of the plugin to be used

Returns:

The plugin which has been used against the project.

hasPlugin

public boolean hasPlugin(String id)

Description copied from interface: PluginContainer

Returns true if the container has a plugin with the given id, false otherwise.

Specified by:

hasPlugin in interface PluginContainer

Parameters:

id - The id of the plugin

hasPlugin

public boolean hasPlugin(Class<? extends Plugin> type)

Description copied from interface: PluginContainer

Returns true if the container has a plugin with the given type, false otherwise.

Specified by:

hasPlugin in interface PluginContainer

Parameters:

type - The type of the plugin

findPlugin

public Plugin findPlugin(String id)

Description copied from interface: PluginContainer

Returns the plugin for the given id.

Specified by:

findPlugin in interface PluginContainer

Parameters:

id - The id of the plugin

Returns:

the plugin or null if no plugin for the given id exists.

findPlugin

public <T extends Plugin> T findPlugin(Class<T> type)

Description copied from interface: PluginContainer

Returns the plugin for the given type.

Specified by:

findPlugin in interface PluginContainer

Parameters:

type - The type of the plugin

Returns:

the plugin or null if no plugin for the given type exists.

getPlugin

public Plugin getPlugin(String id)

Description copied from interface: PluginContainer

Returns a plugin with the specified id if this plugin has been used in the project.

Specified by:

getPlugin in interface PluginContainer

Parameters:

id - The id of the plugin

getAt

public Plugin getAt(String id)
             throws UnknownPluginException

Description copied from interface: PluginContainer

Returns a plugin with the specified id if this plugin has been used in the project. You can use the Groovy [] operator to call this method from a build script.

Specified by:

getAt in interface PluginContainer

Parameters:

id - The id of the plugin

Throws:

UnknownPluginException - When there is no plugin with the given id.

getAt

public <T extends Plugin> T getAt(Class<T> type)
                       throws UnknownPluginException

Description copied from interface: PluginContainer

Returns a plugin with the specified type if this plugin has been used in the project. You can use the Groovy [] operator to call this method from a build script.

Specified by:

getAt in interface PluginContainer

Parameters:

type - The type of the plugin

Throws:

UnknownPluginException - When there is no plugin with the given type.

getPlugin

public <T extends Plugin> T getPlugin(Class<T> type)
                           throws UnknownPluginException

Description copied from interface: PluginContainer

Returns a plugin with the specified type if this plugin has been used in the project.

Specified by:

getPlugin in interface PluginContainer

Parameters:

type - The type of the plugin

Throws:

UnknownPluginException - When there is no plugin with the given type.

getTypeForId

protected Class<? extends Plugin> getTypeForId(String id)