001//
002// MIT License
003//
004// Copyright (c) 2021 Alexander Söderberg & Contributors
005//
006// Permission is hereby granted, free of charge, to any person obtaining a copy
007// of this software and associated documentation files (the "Software"), to deal
008// in the Software without restriction, including without limitation the rights
009// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
010// copies of the Software, and to permit persons to whom the Software is
011// furnished to do so, subject to the following conditions:
012//
013// The above copyright notice and this permission notice shall be included in all
014// copies or substantial portions of the Software.
015//
016// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
017// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
018// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
019// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
020// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
021// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
022// SOFTWARE.
023//
024package cloud.commandframework.services;
025
026import org.checkerframework.checker.nullness.qual.NonNull;
027
028import java.util.Objects;
029import java.util.concurrent.Executor;
030import java.util.concurrent.Executors;
031
032/**
033 * Builder for {@link ServicePipeline}
034 */
035@SuppressWarnings("unused")
036public final class ServicePipelineBuilder {
037
038    private Executor executor = Executors.newSingleThreadExecutor();
039
040    ServicePipelineBuilder() {
041    }
042
043    /**
044     * Construct a new {@link ServicePipeline} using the options specified in the builder
045     *
046     * @return New service pipeline
047     */
048    public @NonNull ServicePipeline build() {
049        return new ServicePipeline(this.executor);
050    }
051
052    /**
053     * Set the executor that will be used by the pipeline when evaluating results asynchronously.
054     * Unless specified, the pipeline will use a single threaded executor.
055     *
056     * @param executor New executor
057     * @return Builder instance
058     */
059    public @NonNull ServicePipelineBuilder withExecutor(final @NonNull Executor executor) {
060        this.executor = Objects.requireNonNull(executor, "Executor may not be null");
061        return this;
062    }
063
064}