dev.mccue.tools.ExitStatusException Maven / Gradle / Ivy

Go to download
package dev.mccue.tools;

import java.io.Serial;

/**
 * When thrown, indicates that the exit status has changed due
 * to the operation execution.
 *
 * @author Geert Bevin (gbevin[remove] at uwyn dot com)
 * @since 1.5
 */
public final class ExitStatusException extends Exception {
    public static final int EXIT_SUCCESS = 0;
    public static final int EXIT_FAILURE = 1;

    @Serial
    private static final long serialVersionUID = 5474282790384325513L;

    private final int exitStatus_;

    public ExitStatusException(int exitStatus) {
        exitStatus_ = exitStatus;
    }

    public int getExitStatus() {
        return exitStatus_;
    }

    /**
     * Throws an {@code ExitStatusException} when the status is a failure.
     *
     * @param status the status to check
     * @throws ExitStatusException when the provided status is different from {@code EXIT_SUCCESS}
     * @since 1.5.7
     */
    public static void throwOnFailure(int status)
            throws ExitStatusException {
        if (status != EXIT_SUCCESS) {
            throw new ExitStatusException(status);
        }
    }
}