bt.service.LifecycleBinding Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of bt-core Show documentation
BitTorrent Client Library (Core)
The newest version!
/*
 * Copyright (c) 2016—2021 Andrei Tomashpolskiy and individual contributors.
 *
 * 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 bt.service;

import bt.runtime.Config;

import java.time.Duration;
import java.util.Objects;
import java.util.Optional;

/**
 * @since 1.1
 */
public class LifecycleBinding {

    /**
     * @since 1.1
     */
    public static Builder bind(Runnable r) {
        return new Builder(r);
    }

    private Optional description;
    private Runnable r;
    private boolean async;

    private LifecycleBinding(String description, Runnable r, boolean async) {
        this.description = Optional.ofNullable(description);
        this.r = r;
        this.async = async;
    }

    /**
     * @since 1.1
     */
    public Optional getDescription() {
        return description;
    }

    /**
     * @since 1.1
     */
    public Runnable getRunnable() {
        return r;
    }

    /**
     * @since 1.1
     */
    public boolean isAsync() {
        return async;
    }

    /**
     * @since 1.1
     */
    public static class Builder {

        private Runnable r;
        private String description;
        private boolean async;

        private Builder(Runnable r) {
            this.r = Objects.requireNonNull(r);
        }

        /**
         * @param description Human-readable description
         * @since 1.1
         */
        public Builder description(String description) {
            this.description = Objects.requireNonNull(description);
            return this;
        }

        /**
         * Mark this binding for asynchronous execution
         *
         * @see Config#setShutdownHookTimeout(Duration)
         * @since 1.1
         */
        public Builder async() {
            this.async = true;
            return this;
        }

        /**
         * @since 1.1
         */
        public LifecycleBinding build() {
            return new LifecycleBinding(description, r, async);
        }
    }
}