net.kemitix.mon.result.CheckedErrorResultException Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mon Show documentation

TypeAlias, Result and Maybe for Java

There is a newer version: 3.2.0

/**
 * The MIT License (MIT)
 *
 * Copyright (c) 2021 Paul Campbell
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
 * and associated documentation files (the "Software"), to deal in the Software without restriction,
 * including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so,
 * subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all copies
 * or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
 * INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE
 * AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */

package net.kemitix.mon.result;

/**
 * A checked wrapper for exceptions thrown within a {@link Result}.
 *
 * Used by {@link Result#orElseThrow()} when the {@link Result} is an error.
 *
 * @author Paul Campbell ([email protected])
 */
public final class CheckedErrorResultException extends Exception {

    private static final long serialVersionUID = 6388860431020999870L;

    private CheckedErrorResultException(final Throwable cause) {
        super(cause);
    }

    /**
     * Creates a new object.
     *
     * @param cause the cause
     * @return a {@link CheckedErrorResultException} containing the cause
     */
    static CheckedErrorResultException with(final Throwable cause) {
        return new CheckedErrorResultException(cause);
    }
}