Overview | Package | Class | Deprecated | Index | Help
| Groovy Documentation
| FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | METHOD | DETAIL: FIELD | METHOD

## org.gradle.api.plugins
[Java] Interface PluginContainer

    org.gradle.api.plugins.PluginContainer
      java.lang.Iterable
          org.gradle.api.DomainObjectCollection
              org.gradle.api.plugins.PluginCollection
                  java.util.Collection
                      org.gradle.api.DomainObjectSet

All Superinterfaces:
  Iterable, DomainObjectCollection, PluginCollection, Collection, DomainObjectSet

    public interface PluginContainer
    extends PluginCollection

A `PluginContainer` is used to manage a set of Plugin instances applied to a particular project.

Plugins can be specified using either an id or type. The id of a plugin is specified using a META-INF/gradle-plugins/${id}.properties classpath resource.

Method Summary
`Plugin` | `apply(String id)` Has the same behavior as apply(Class) except that the the plugin is specified via its id.
`Object` | `apply(Class type)` Applies a plugin to the project.
`Plugin` | `findPlugin(String id)` Returns the plugin for the given id.
`Object` | `findPlugin(Class type)` Returns the plugin for the given type.
`Plugin` | `getAt(String id)` Returns a plugin with the specified id if this plugin has been used in the project.
`Object` | `getAt(Class 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.
`Object` | `getPlugin(Class type)` Returns a plugin with the specified type if this plugin has been used in the project.
`boolean` | `hasPlugin(String id)` Returns true if the container has a plugin with the given id, false otherwise.
`boolean` | `hasPlugin(Class type)` Returns true if the container has a plugin with the given type, false otherwise.

Methods inherited from interface PluginCollection
matching, matching, whenPluginAdded, whenPluginAdded, withType

Methods inherited from interface DomainObjectSet
findAll, matching, matching, withType

Methods inherited from interface DomainObjectCollection
all, all, findAll, matching, matching, whenObjectAdded, whenObjectAdded, whenObjectRemoved, whenObjectRemoved, withType, withType, withType

Methods inherited from interface Set
add, equals, hashCode, clear, contains, isEmpty, size, toArray, toArray, addAll, iterator, remove, containsAll, removeAll, retainAll

Method Detail

### apply

    public Plugin apply(String id)

  Has the same behavior as apply(Class) except that the the plugin is specified via its id. Not all plugins have an id.
  Parameters:
    `id` - The id of the plugin to be applied.
  Returns:
    The plugin which has been used against the project.

### apply

    public Object apply(Class type)

  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.
  Parameters:
    `type` - The type of the plugin to be used
  Returns:
    The plugin which has been used against the project.

### findPlugin

    public Plugin findPlugin(String id)

  Returns the plugin for the given id.
  Parameters:
    `id` - The id of the plugin
  Returns:
    the plugin or null if no plugin for the given id exists.

### findPlugin

    public Object findPlugin(Class type)

  Returns the plugin for the given type.
  Parameters:
    `type` - The type of the plugin
  Returns:
    the plugin or null if no plugin for the given type exists.

### getAt

    public Plugin getAt(String id)

  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.
  throws:
    UnknownPluginException When there is no plugin with the given id.
  Parameters:
    `id` - The id of the plugin

### getAt

    public Object getAt(Class type)

  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.
  throws:
    UnknownPluginException When there is no plugin with the given type.
  Parameters:
    `type` - The type of the plugin

### getPlugin

    public Plugin getPlugin(String id)

  Returns a plugin with the specified id if this plugin has been used in the project.
  throws:
    UnknownPluginException When there is no plugin with the given id.
  Parameters:
    `id` - The id of the plugin

### getPlugin

    public Object getPlugin(Class type)

  Returns a plugin with the specified type if this plugin has been used in the project.
  throws:
    UnknownPluginException When there is no plugin with the given type.
  Parameters:
    `type` - The type of the plugin

### hasPlugin

    public boolean hasPlugin(String id)

  Returns true if the container has a plugin with the given id, false otherwise.
  Parameters:
    `id` - The id of the plugin

### hasPlugin

    public boolean hasPlugin(Class type)

  Returns true if the container has a plugin with the given type, false otherwise.
  Parameters:
    `type` - The type of the plugin

Gradle API 1.10