com.speedment.runtime.core.manager.ManagerConfigurator Maven / Gradle / Ivy

/**
 *
 * Copyright (c) 2006-2019, Speedment, Inc. All Rights Reserved.
 *
 * 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 com.speedment.runtime.core.manager;

import com.speedment.runtime.core.stream.parallel.ParallelStrategy;

/**
 * This class makes it possible to decorate a manager with a special 
 * parallelization strategy by using a builder pattern.
 * 
 * @param   the entity type
 * 
 * @author  Per Minborg
 * @since   3.0.1
 */
public interface ManagerConfigurator {

    /**
     * Set the parallelization strategy to use in the built manager.
     * 
     * @param parallelStrategy  the parallelization strategy
     * @return                  a reference to this instance
     */
    ManagerConfigurator withParallelStrategy(ParallelStrategy parallelStrategy);

    /**
     * Builds a new manager that might delegate some methods to the pre-existing 
     * manager, but where the specified settings will be applied upon execution.
     * 
     * @return  the built manager
     */
    Manager build();

}