Table of Contents
API Documentation: | AuthenticationContainer |
---|
Note: This class is incubating and may change in a future version of Gradle.
Container for configuring repository authentication schemes of type Authentication
.
Method | Description |
containerWithType(type) | Incubating Creates a regular container that wraps the polymorphic container presenting all elements of a specified type. |
create(name) | Creates a new item with the given name, adding it to this container. |
create(name, configureClosure) | Creates a new item with the given name, adding it to this container, then configuring it with the given closure. |
create(name, type) | Incubating Creates a domain object with the specified name and type, and adds it to the container. |
create(name, type, configuration) | Incubating Creates a domain object with the specified name and type, adds it to the container, and configures it with the specified action. |
create(name, configureAction) | Creates a new item with the given name, adding it to this container, then configuring it with the given action. |
getByName(name) | Locates an object by name, failing if there is no such object. |
getByName(name, configureClosure) | Locates an object by name, failing if there is no such object. The given configure closure is executed against the object before it is returned from this method. The object is passed to the closure as its delegate. |
getByName(name, configureAction) | Locates an object by name, failing if there is no such object. The given configure action is executed against the object before it is returned from this method. |
maybeCreate(name) | Looks for an item with the given name, creating and adding it to this container if it does not exist. |
maybeCreate(name, type) | Incubating Looks for an item with the given name and type, creating and adding it to this container if it does not exist. |
named(name) | Incubating Locates a object by name, without triggering its creation or configuration, failing if there is no such object. |
register(name) | Incubating Defines a new object, which will be created when it is required. A object is 'required' when the object is located using query methods such as |
register(name, configurationAction) | Incubating Defines a new object, which will be created and configured when it is required. An object is 'required' when the object is located using query methods such as |
NamedDomainObjectContainer
<U
>
containerWithType
(Class
<U
>
type)
NamedDomainObjectContainer
<U
>Class
<U
>Note: This method is incubating and may change in a future version of Gradle.
Creates a regular container that wraps the polymorphic container presenting all elements of a specified type.
T
create
(String
name)
Creates a new item with the given name, adding it to this container.
Creates a new item with the given name, adding it to this container, then configuring it with the given closure.
Note: This method is incubating and may change in a future version of Gradle.
Creates a domain object with the specified name and type, and adds it to the container.
Note: This method is incubating and may change in a future version of Gradle.
Creates a domain object with the specified name and type, adds it to the container, and configures it with the specified action.
Creates a new item with the given name, adding it to this container, then configuring it with the given action.
T
getByName
(String
name)
Locates an object by name, failing if there is no such object.
Locates an object by name, failing if there is no such object. The given configure closure is executed against the object before it is returned from this method. The object is passed to the closure as its delegate.
Locates an object by name, failing if there is no such object. The given configure action is executed against the object before it is returned from this method.
T
maybeCreate
(String
name)
Looks for an item with the given name, creating and adding it to this container if it does not exist.
Note: This method is incubating and may change in a future version of Gradle.
Looks for an item with the given name and type, creating and adding it to this container if it does not exist.
NamedDomainObjectProvider
<T
>
named
(String
name)
NamedDomainObjectProvider
<T
>Note: This method is incubating and may change in a future version of Gradle.
Locates a object by name, without triggering its creation or configuration, failing if there is no such object.
NamedDomainObjectProvider
<T
>
register
(String
name)
NamedDomainObjectProvider
<T
>Note: This method is incubating and may change in a future version of Gradle.
Defines a new object, which will be created when it is required. A object is 'required' when the object is located using query methods such as NamedDomainObjectCollection.getByName(java.lang.String)
or when Provider.get()
is called on the return value of this method.
It is generally more efficient to use this method instead of NamedDomainObjectContainer.create(java.lang.String)
, as that methods will eagerly create he object, regardless of whether that object is required for the current build or not. This method, on the other hand, will defer creation until required.
NamedDomainObjectProvider
<T
>
register
(String
name, Action
<? super T
>
configurationAction)
NamedDomainObjectProvider
<T
>Action
<? super T
>Note: This method is incubating and may change in a future version of Gradle.
Defines a new object, which will be created and configured when it is required. An object is 'required' when the object is located using query methods such as NamedDomainObjectCollection.getByName(java.lang.String)
or when Provider.get()
is called on the return value of this method.
It is generally more efficient to use this method instead of NamedDomainObjectContainer.create(java.lang.String, org.gradle.api.Action)
or NamedDomainObjectContainer.create(java.lang.String)
, as those methods will eagerly create and configure the object, regardless of whether that object is required for the current build or not. This method, on the other hand, will defer creation and configuration until required.