org.gradle.api.model.ObjectFactory Maven / Gradle / Ivy
Show all versions of gradle-api Show documentation
/*
* Copyright 2017 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.gradle.api.model;
import org.gradle.api.DomainObjectSet;
import org.gradle.api.ExtensiblePolymorphicDomainObjectContainer;
import org.gradle.api.Incubating;
import org.gradle.api.Named;
import org.gradle.api.NamedDomainObjectContainer;
import org.gradle.api.NamedDomainObjectFactory;
import org.gradle.api.NamedDomainObjectList;
import org.gradle.api.NamedDomainObjectSet;
import org.gradle.api.artifacts.dsl.DependencyCollector;
import org.gradle.api.file.ConfigurableFileCollection;
import org.gradle.api.file.ConfigurableFileTree;
import org.gradle.api.file.DirectoryProperty;
import org.gradle.api.file.RegularFileProperty;
import org.gradle.api.file.SourceDirectorySet;
import org.gradle.api.provider.ListProperty;
import org.gradle.api.provider.MapProperty;
import org.gradle.api.provider.Property;
import org.gradle.api.provider.SetProperty;
import org.gradle.api.reflect.ObjectInstantiationException;
import org.gradle.internal.service.scopes.Scope;
import org.gradle.internal.service.scopes.ServiceScope;
import java.util.List;
import java.util.Map;
import java.util.Set;
/**
* A factory for creating various kinds of model objects.
*
* An instance of the factory can be injected into a task, plugin or other object by annotating a public constructor or property getter method with {@code javax.inject.Inject}.
* It is also available via {@link org.gradle.api.Project#getObjects()}.
*
* @since 4.0
*/
@ServiceScope({Scope.Global.class, Scope.Project.class})
public interface ObjectFactory {
/**
* Creates a simple immutable {@link Named} object of the given type and name.
*
*
The given type can be an interface that extends {@link Named} or an abstract class that 'implements' {@link Named}. An abstract class, if provided:
*
* - Must provide a zero-args constructor that is not private.
* - Must not define or inherit any instance fields.
* - Should not provide an implementation for {@link Named#getName()} and should define this method as abstract. Any implementation will be overridden.
* - Must not define or inherit any other abstract methods.
*
*
* An interface, if provided, must not define or inherit any other methods.
*
* Objects created using this method are not decorated or extensible.
*
* @throws ObjectInstantiationException On failure to create the new instance.
* @since 4.0
*/
T named(Class type, String name) throws ObjectInstantiationException;
/**
* Create a new instance of T, using {@code parameters} as the construction parameters.
*
* The type must be non-final, and can be a class, abstract class or interface.
*
* Objects created using this method are decorated and extensible, meaning that they have DSL support mixed in and can be extended using the `extensions` property, similar to the {@link org.gradle.api.Project} object.
*
* An @Inject annotation is required on any constructor that accepts parameters because JSR-330 semantics for dependency injection are used. In addition to those parameters provided as an argument to this method, the following services are also available for injection:
*
*
* - {@link ObjectFactory}.
* - {@link org.gradle.api.file.ProjectLayout}.
* - {@link org.gradle.api.provider.ProviderFactory}.
* - {@link org.gradle.process.ExecOperations}
* - {@link org.gradle.api.file.FileSystemOperations}
*
*
* @throws ObjectInstantiationException On failure to create the new instance.
* @since 4.2
*/
T newInstance(Class type, Object... parameters) throws ObjectInstantiationException;
/**
* Creates a {@link SourceDirectorySet}.
*
* @param name A short name for the set.
* @param displayName A human consumable display name for the set.
* @since 5.0
*/
SourceDirectorySet sourceDirectorySet(String name, String displayName);
/**
* Creates a new {@link ConfigurableFileCollection}. The collection is initially empty.
*
* @since 5.3
*/
ConfigurableFileCollection fileCollection();
/**
* Creates a new {@link ConfigurableFileTree}. The tree will have no base dir specified.
*
* @since 6.0
*/
ConfigurableFileTree fileTree();
/**
* Creates a new {@link NamedDomainObjectContainer} for managing named objects of the specified type.
*
* The specified element type must have a public constructor which takes the name as a String parameter. The type must be non-final and a class or abstract class.
*
* Interfaces are supported if they declare a read-only {@code name} property of type String, and are otherwise empty or consist entirely of managed properties.
*
* All objects MUST expose their name as a bean property called "name". The name must be constant for the life of the object.
*
* The objects created by the container are decorated and extensible, and have services available for injection. See {@link #newInstance(Class, Object...)} for more details.
*
* @param elementType The type of objects for the container to contain.
* @param The type of objects for the container to contain.
* @return The container. Never returns null.
* @since 5.5
*/
NamedDomainObjectContainer domainObjectContainer(Class elementType);
/**
* Creates a new {@link NamedDomainObjectContainer} for managing named objects of the specified type. The given factory is used to create object instances.
*
* All objects MUST expose their name as a bean property named "name". The name must be constant for the life of the object.
*
* @param elementType The type of objects for the container to contain.
* @param factory The factory to use to create object instances.
* @param The type of objects for the container to contain.
* @return The container. Never returns null.
* @since 5.5
*/
NamedDomainObjectContainer domainObjectContainer(Class elementType, NamedDomainObjectFactory factory);
/**
* Creates a new {@link ExtensiblePolymorphicDomainObjectContainer} for managing named objects of the specified type.
*
* The returned container will not have any factories or bindings registered.
*
* @param elementType The type of objects for the container to contain.
* @param The type of objects for the container to contain.
* @return The container.
* @since 6.1
*/
ExtensiblePolymorphicDomainObjectContainer polymorphicDomainObjectContainer(Class elementType);
/**
* Creates a new {@link DomainObjectSet} for managing objects of the specified type.
*
* @param elementType The type of objects for the domain object set to contain.
* @param The type of objects for the domain object set to contain.
* @return The domain object set. Never returns null.
* @since 5.5
*/
DomainObjectSet domainObjectSet(Class elementType);
/**
* Creates a new {@link NamedDomainObjectSet} for managing named objects of the specified type.
*
* All objects MUST expose their name as a bean property called "name". The name must be constant for the life of the object.
*
* @param elementType The type of objects for the domain object set to contain.
* @param The type of objects for the domain object set to contain.
* @return The domain object set.
* @since 6.1
*/
NamedDomainObjectSet namedDomainObjectSet(Class elementType);
/**
* Creates a new {@link NamedDomainObjectList} for managing named objects of the specified type.
*
* All objects MUST expose their name as a bean property called "name". The name must be constant for the life of the object.
*
* @param elementType The type of objects for the domain object set to contain.
* @param The type of objects for the domain object set to contain.
* @return The domain object list.
* @since 6.1
*/
NamedDomainObjectList namedDomainObjectList(Class elementType);
/**
* Creates a {@link Property} implementation to hold values of the given type. The property has no initial value.
*
* For certain types, there are more specialized property factory methods available:
*
* - For {@link List} properties, you should use {@link #listProperty(Class)}.
* - For {@link Set} properties, you should use {@link #setProperty(Class)}.
* - For {@link Map} properties, you should use {@link #mapProperty(Class, Class)}.
* - For {@link org.gradle.api.file.Directory} properties, you should use {@link #directoryProperty()}.
* - For {@link org.gradle.api.file.RegularFile} properties, you should use {@link #fileProperty()}.
*
*
* @param valueType The type of the property.
* @return The property. Never returns null.
* @since 4.3
*/
Property property(Class valueType);
/**
* Creates a {@link ListProperty} implementation to hold a {@link List} of the given element type {@code T}. The property has an empty list as its initial value.
*
* The implementation will return immutable {@link List} values from its query methods.
*
* @param elementType The type of element.
* @param The type of element.
* @return The property. Never returns null.
* @since 4.3
*/
ListProperty listProperty(Class elementType);
/**
* Creates a {@link SetProperty} implementation to hold a {@link Set} of the given element type {@code T}. The property has an empty set as its initial value.
*
* The implementation will return immutable {@link Set} values from its query methods.
*
* @param elementType The type of element.
* @param The type of element.
* @return The property. Never returns null.
* @since 4.5
*/
SetProperty setProperty(Class elementType);
/**
* Creates a {@link MapProperty} implementation to hold a {@link Map} of the given key type {@code K} and value type {@code V}. The property has an empty map as its initial value.
*
* The implementation will return immutable {@link Map} values from its query methods.
*
* @param keyType the type of key.
* @param valueType the type of value.
* @param the type of key.
* @param the type of value.
* @return the property. Never returns null.
* @since 5.1
*/
MapProperty mapProperty(Class keyType, Class valueType);
/**
* Creates a new {@link DirectoryProperty} that uses the project directory to resolve relative paths, if required. The property has no initial value.
*
* @since 5.0
*/
DirectoryProperty directoryProperty();
/**
* Creates a new {@link RegularFileProperty} that uses the project directory to resolve relative paths, if required. The property has no initial value.
*
* @since 5.0
*/
RegularFileProperty fileProperty();
/**
* Creates a new {@link DependencyCollector} used for declaring dependencies.
*
* Avoid this method if possible and use managed object instantiation instead.
*
* @since 8.6
*/
@Incubating
DependencyCollector dependencyCollector();
}