be.yildizgames.common.exception.implementation.ImplementationException Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of common-exception Show documentation

Common Exception library for the yildiz project, contains technical and business exceptions.

There is a newer version: 1.0.4

/*
 * This file is part of the Yildiz-Engine project, licenced under the MIT License  (MIT)
 *
 *  Copyright (c) 2018 Grégory Van den Borre
 *
 *  More infos available: https://www.yildiz-games.be
 *
 *  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 be.yildizgames.common.exception.implementation;

/**
 * A development exception only occurs when a mistake has been done during the implementation.
 * @author Grégory Van den Borre
 */
public class ImplementationException extends RuntimeException {

    private ImplementationException(String message) {
        super(message);
    }

    public static void throwForNull(Object o) {
        if(o == null) {
            throw new ImplementationException("Null value is not allowed");
        }
    }

    public static void throwIfZeroOrSmaller(int value) {
        if(value <= 0) {
            throw new ImplementationException("Only values higher than 0 allowed, cannot accept " + value);
        }
    }

    public static void throwIfZeroOrSmaller(float value) {
        if(value < 0) {
            throw new ImplementationException("Only values higher than 0 allowed, cannot accept " + value);
        }
    }

    public static void notYetImplemented() {
        throw new ImplementationException("This method is not yet implemented.");
    }

    public static ImplementationException missingImplementation(String module) {
        return new ImplementationException("Missing implementation for module " + module);
    }
}