InstantiatorFactory.java

/*
 * 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.internal;

import org.gradle.internal.reflect.Instantiator;
import org.gradle.internal.service.ServiceRegistry;

public interface InstantiatorFactory {
    /**
     * Creates an {@link Instantiator} that can inject services and user provided values into the instances it creates, but does not decorate the instances.
     *
     * <p>Use for any public types for which services or user provided values need to injected.
     *
     * @param registry The registry of services to make available to instances.
     * @return The instantiator
     */
    Instantiator inject(ServiceRegistry registry);

    /**
     * Creates an {@link Instantiator} that can inject user provided values into the instances it creates, but does not decorate the instances.
     *
     * <p>Use for any public types for which user provided values need to injected.
     *
     * @return The instantiator
     */
    Instantiator inject();

    /**
     * Creates an {@link Instantiator} that decorates the instances created.
     *
     * <p>Use for any public model types for which no user provided values need to injected.
     *
     * @return The instantiator
     */
    Instantiator decorate();

    /**
     * Creates an {@link Instantiator} that can inject services and user provided values into the instances it creates and also decorates the instances.
     *
     * <p>Use for any public model types for which services or user provided values need to injected.
     *
     * @param registry The registry of services to make available to instances.
     * @return The instantiator
     */
    Instantiator injectAndDecorate(ServiceRegistry registry);
}