co.unruly.control.Unit Maven / Gradle / Ivy

Go to download
package co.unruly.control;

import java.util.function.Consumer;
import java.util.function.Function;

/**
 * Unit type, which contains only one possible value.
 * 
 * This exists to offer a bridge between void and regular functions, providing
 * convenience methods to convert between them.
 */
public enum Unit {

    UNIT;

    /**
     * Converts a Consumer to a Function, which returns Unit.UNIT
     */
    public static  Function functify(Consumer toVoid) {
        return x -> {
            toVoid.accept(x);
            return Unit.UNIT;
        };
    }

    /**
     * Converts a Function to a Consumer, throwing away the return value
     */
    public static  Consumer voidify(Function function) {
        return function::apply;
    }

    /**
     * A no-op function which takes any argument, does nothing, and returns Unit.UNIT
     */
    public static  Unit noOp(T __) {
        return UNIT;
    }

    /**
     * A no-op consumer which takes any argument and does nothing
     */
    public static  void noOpConsumer(T __) {
        // do nothing
    }
}