org.neo4j.kernel.lifecycle.Lifespan Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of neo4j-common Show documentation

Non-domain infrastructure code that is common to many Neo4j components.

The newest version!

/*
 * Copyright (c) "Neo4j"
 * Neo4j Sweden AB [https://neo4j.com]
 *
 * This file is part of Neo4j.
 *
 * Neo4j is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see .
 */
package org.neo4j.kernel.lifecycle;

/**
 * Convenient use of a {@link LifeSupport}, effectively making one or more {@link Lifecycle} look and feel
 * like one {@link AutoCloseable}.
 */
public class Lifespan extends LifeSupport implements AutoCloseable {

    private Lifespan() {}

    /**
     * @param subjects the subjects to be managed by the lifecycle. NOTE The lifecycle will have the
     * state {@link LifecycleStatus#STARTED} after all the subjects are added
     */
    public Lifespan(Lifecycle... subjects) {
        this();
        addAll(subjects);
        start();
    }

    /**
     * @param subjects the subjects to be managed by the lifecycle. NOTE The lifecycle will still have
     * the state {@link LifecycleStatus#NONE} after all the subjects are added and {@link Lifecycle#init()} will
     * need to be called manually.
     * @return the initialized lifespan
     */
    public static Lifespan createWithNoneState(Lifecycle... subjects) {
        final var lifespan = new Lifespan();
        lifespan.addAll(subjects);
        return lifespan;
    }

    @Override
    public void close() {
        shutdown();
    }

    private void addAll(Lifecycle... subjects) {
        for (Lifecycle subject : subjects) {
            add(subject);
        }
    }
}