org.gradle.api.internal.FactoryNamedDomainObjectContainer Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gradle-api Show documentation
Gradle 6.9.1 API redistribution.
There is a newer version: 8.11.1
/*
 * Copyright 2011 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.internal;

import groovy.lang.Closure;
import org.gradle.api.Namer;
import org.gradle.api.Named;
import org.gradle.api.NamedDomainObjectFactory;
import org.gradle.internal.reflect.Instantiator;

public class FactoryNamedDomainObjectContainer extends AbstractNamedDomainObjectContainer {

    private final NamedDomainObjectFactory factory;

    /**
     * Creates a container that instantiates reflectively, expecting a 1 arg constructor taking the name.

     *
     * 
The type must implement the {@link Named} interface as a {@link Namer} will be created based on this type.
     *
     * @param type The concrete type of element in the container (must implement {@link Named})
     * @param instantiator The instantiator to use to create any other collections based on this one
     */
    public FactoryNamedDomainObjectContainer(Class type, Instantiator instantiator) {
        this(type, instantiator, Named.Namer.forType(type));
    }

    /**
     * Creates a container that instantiates reflectively, expecting a 1 arg constructor taking the name.

     *
     * @param type The concrete type of element in the container (must implement {@link Named})
     * @param instantiator The instantiator to use to create any other collections based on this one
     * @param namer The naming strategy to use
     */
    public FactoryNamedDomainObjectContainer(Class type, Instantiator instantiator, Namer namer) {
        this(type, instantiator, namer, new ReflectiveNamedDomainObjectFactory(type));
    }

    /**
     * 
Creates a container that instantiates using the given factory.

     *
     * @param type The concrete type of element in the container (must implement {@link Named})
     * @param instantiator The instantiator to use to create any other collections based on this one
     * @param factory The factory responsible for creating new instances on demand
     */
    public FactoryNamedDomainObjectContainer(Class type, Instantiator instantiator, NamedDomainObjectFactory factory) {
        this(type, instantiator, Named.Namer.forType(type), factory);
    }

    /**
     * 
Creates a container that instantiates using the given factory.

     *
     * @param type The concrete type of element in the container
     * @param instantiator The instantiator to use to create any other collections based on this one
     * @param namer The naming strategy to use
     * @param factory The factory responsible for creating new instances on demand
     */
    public FactoryNamedDomainObjectContainer(Class type, Instantiator instantiator, Namer namer, NamedDomainObjectFactory factory) {
        super(type, instantiator, namer);
        this.factory = factory;
    }

    /**
     * 
Creates a container that instantiates using the given factory.

     *
     * @param type The concrete type of element in the container (must implement {@link Named})
     * @param instantiator The instantiator to use to create any other collections based on this one
     * @param factoryClosure The closure responsible for creating new instances on demand
     */
    public FactoryNamedDomainObjectContainer(Class type, Instantiator instantiator, final Closure factoryClosure) {
        this(type, instantiator, Named.Namer.forType(type), factoryClosure);
    }

    /**
     * 
Creates a container that instantiates using the given factory.
     *
     * @param type The concrete type of element in the container
     * @param instantiator The instantiator to use to create any other collections based on this one
     * @param namer The naming strategy to use
     * @param factoryClosure The factory responsible for creating new instances on demand
     */
    public FactoryNamedDomainObjectContainer(Class type, Instantiator instantiator, Namer namer, final Closure factoryClosure) {
        this(type, instantiator, namer, new ClosureObjectFactory(type, factoryClosure));
    }

    @Override
    protected T doCreate(String name) {
        return factory.create(name);
    }

    private static class ClosureObjectFactory implements NamedDomainObjectFactory {
        private final Class type;
        private final Closure factoryClosure;

        public ClosureObjectFactory(Class type, Closure factoryClosure) {
            this.type = type;
            this.factoryClosure = factoryClosure;
        }

        public T create(String name) {
            return type.cast(factoryClosure.call(name));
        }
    }
}