net.kemitix.mon.result.package-info 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

The newest version!

/**
 * 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.
 */

/**
 * <h1>Result</h1>
 *
 * Allows handling error conditions without the need to {@code catch}
 * exceptions.
 *
 * When a {@link Result} is returned from a method, it will be in one of two
 * states: {@link Success} or {@link Err}. The {@code Success} state will
 * contain a value from the method. The {@code Err} state will contain a
 * {@link java.lang.Throwable} detailing the reason for the failure.
 *
 * Methods returning a {@code Result} should not throw any exceptions.
 *
 * {@code Result} is a Monad.
 *
 * Static Constructors:
 * 
 *     {@link Result#ok()}
 *     {@link Result#ok(Object)}
 *     {@link Result#of(Callable)}
 *     {@link Result#ofVoid(VoidCallable)}
 *     {@link Result#error(Throwable)}
 * 
 *
 * @author Paul Campbell ([email protected])
 */

package net.kemitix.mon.result;