com.swirlds.base.state.Lifecycle Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of swirlds-base Show documentation

Swirlds is a software platform designed to build fully-distributed applications that harness the power of the cloud without servers. Now you can develop applications with fairness in decision making, speed, trust and reliability, at a fraction of the cost of traditional server-based platforms.

There is a newer version: 0.56.6

Show newest version

/*
 * Copyright (C) 2023 Hedera Hashgraph, LLC
 *
 * 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.swirlds.base.state;

import edu.umd.cs.findbugs.annotations.NonNull;
import edu.umd.cs.findbugs.annotations.Nullable;
import java.util.Objects;

/**
 * An object with a well-defined start/stop lifecycle.
 */
public interface Lifecycle extends Startable, Stoppable {

    /**
     * Get the current phase of this object.
     *
     * @return the object's current lifecycle phase
     */
    @NonNull
    LifecyclePhase getLifecyclePhase();

    /**
     * Throw an exception if the object is not in the expected phase.
     *
     * @param phase the expected phase
     * @throws LifecycleException if the object is not in the expected phase
     */
    default void throwIfNotInPhase(@NonNull final LifecyclePhase phase) {
        throwIfNotInPhase(phase, "object is in an unexpected phase");
    }

    /**
     * Throw an exception if the object is not in the expected phase.
     *
     * @param phase        the expected phase
     * @param errorMessage a message that provides additional information if an exception is thrown
     * @throws LifecycleException if the object is not in the expected phase
     */
    default void throwIfNotInPhase(@NonNull final LifecyclePhase phase, @Nullable final String errorMessage) {
        Objects.requireNonNull(phase, "phase must not be null");
        final LifecyclePhase currentPhase = getLifecyclePhase();
        if (currentPhase != phase) {
            throw new LifecycleException(
                    errorMessage + ": current phase = " + currentPhase + ", expected phase = " + phase);
        }
    }
}