com.biz.common.error.BizXException Maven / Gradle / Ivy

Go to download

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

BizX 是一个灵活而高效的业务开发框架, 其中也有很多为业务开发所需要的工具类的提供。

The newest version!

package com.biz.common.error;

/**
 * BizX 最高异常类接口。
 * 定义了获取错误码和错误信息的方法，用于所有 BizX 相关异常的基类。
 * 该抽象类继承自 {@link RuntimeException}，并要求子类实现获取错误码 {@code getCode()} 和错误信息 {@code getMessage()} 的方法。
 *
 * 示例代码：
 * {@code
 *     public class CustomBizXException extends BizXException {
 *         private final int code;
 *         private final String message;
 *
 *         public CustomBizXException(int code, String message) {
 *             this.code = code;
 *             this.message = message;
 *         }
 *
 *         @Override
 *         public int getCode() {
 *             return code;
 *         }
 *
 *         @Override
 *         public String getMessage() {
 *             return message;
 *         }
 *     }
 * }
 *
 * 该类提供了多个构造函数，以便子类可以根据需要调用父类的构造函数。
 *
 * @author francis
 * @version 1.0.1
 * @since 1.0.1
 */
public abstract class BizXException extends RuntimeException {

    /**
     * 获取错误码。
     *
     * @return 错误码
     */
    public abstract int getCode();

    /**
     * 获取错误信息。
     *
     * @return 错误信息
     */
    public abstract String getMessage();

    /**
     * 默认构造函数。
     */
    public BizXException() {
        super();
    }

    /**
     * 带错误信息的构造函数。
     *
     * @param message 错误信息
     */
    public BizXException(String message) {
        super(message);
    }

    /**
     * 带原始异常信息的构造函数。
     *
     * @param cause 原始异常信息
     */
    public BizXException(Throwable cause) {
        super(cause);
    }

}