ExecutorConfiguration.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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.apache.ignite.configuration;

import org.apache.ignite.IgniteCompute;
import org.apache.ignite.internal.util.typedef.internal.S;

import static org.apache.ignite.configuration.IgniteConfiguration.DFLT_PUBLIC_THREAD_CNT;

/**
 * Сustom thread pool configuration for compute tasks. See {@link IgniteCompute#withAsync()} for more information.
 */
public class ExecutorConfiguration {
    /** Thread pool name. */
    private String name;

    /** Thread pool size. */
    private int size = DFLT_PUBLIC_THREAD_CNT;

    /**
     * Default constructor.
     */
    public ExecutorConfiguration() {
        // No-op.
    }

    /**
     * Constructor.
     *
     * @param name Thread pool name.
     */
    public ExecutorConfiguration(String name) {
        this.name = name;
    }

    /**
     * Copying constructor.
     *
     * @param other Instance to copy.
     */
    public ExecutorConfiguration(ExecutorConfiguration other) {
        assert other != null;

        name = other.name;
        size = other.size;
    }

    /**
     * Get thread pool name.
     * <p>
     * See {@link #setName(String)} for more information.
     *
     * @return Executor name.
     */
    public String getName() {
        return name;
    }

    /**
     * Set thread pool name. Name cannot be {@code null} and should be unique with respect to other custom executors.
     *
     * @param name Executor name.
     * @return {@code this} for chaining.
     */
    public ExecutorConfiguration setName(String name) {
        this.name = name;

        return this;
    }

    /**
     * Get thread pool size.
     * <p>
     * See {@link #setSize(int)} for more information.
     *
     * @return Thread pool size.
     */
    public int getSize() {
        return size;
    }

    /**
     * Set thread pool size.
     * <p>
     * Defaults to {@link IgniteConfiguration#DFLT_PUBLIC_THREAD_CNT}.
     *
     * @param size Thread pool size.
     * @return {@code this} for chaining.
     */
    public ExecutorConfiguration setSize(int size) {
        this.size = size;

        return this;
    }

    /** {@inheritDoc} */
    @Override public String toString() {
        return S.toString(ExecutorConfiguration.class, this);
    }
}