be.yildizgames.common.exception.technical.TechnicalException Maven / Gradle / Ivy
/*
* This file is part of the Yildiz-Engine project, licenced under the MIT License (MIT)
*
* Copyright (c) 2019 Grégory Van den Borre
*
* More infos available: https://engine.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.technical;
/**
* High level exception meant to be sent to the user, this is the exception
* dealing with all technical issues occurring during the application runtime.
* This exception is thrown because of system failure, not user misbehavior.
* This exception cannot be used as such, it must be extended
* Immutable class.
*
* @author Grégory Van den Borre
*/
public class TechnicalException extends RuntimeException {
/***/
private static final long serialVersionUID = -4453166840479422489L;
/**
* Message to display to the user(most probably the key for translation).
*/
public final String message;
protected TechnicalException(final String message, final Exception cause) {
super(cause);
this.message = message;
}
/**
* Create a new instance with a cause and an empty message.
*
* @param cause Root exception.
*/
//@Requires("cause != null")
protected TechnicalException(final Exception cause) {
this("", cause);
}
protected TechnicalException(String s) {
super(s);
this.message = s;
}
}