com.gitee.cn9750wang.webtools.error.defines.ErrEnum Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of web-tools Show documentation
web tools for spring-boot web project
The newest version!
/*
 *    Copyright 2021 wwy
 *
 *    Licensed under the Apache License, Version 2.0 (the "License");
 *    you may not use this file except in compliance with the License.
 *    You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 *    Unless required by applicable law or agreed to in writing, software
 *    distributed under the License is distributed on an "AS IS" BASIS,
 *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *    See the License for the specific language governing permissions and
 *    limitations under the License.
 */
package com.gitee.cn9750wang.webtools.error.defines;

import com.gitee.cn9750wang.webtools.error.P21Exception;
import com.gitee.cn9750wang.webtools.utils.Assert;
import com.gitee.cn9750wang.webtools.vo.result.error.ErrorMessage;

import java.util.Collection;
import java.util.Map;

/**
 * 错误定义 枚举
 *
 * @author wwy
 */
public interface ErrEnum {

    /**
     * 错误信息
     * @return 错误信息
     */
    ErrorMessage getMessage();

    /**
     * 断言表达式为true
     * @param expression 表达式
     * @param obj 异常信息的格式化参数
     * @return 枚举对象本身
     * @throws P21Exception 项目定义的异常
     */
    default ErrEnum isTrue(boolean expression, Object...obj) throws P21Exception {
        Assert.isTrue(expression,getMessage(),obj);
        return this;
    }

    /**
     * 断言表达式为false
     * @param expression 表达式
     * @param obj 异常信息的格式化参数
     * @return 枚举对象本身
     * @throws P21Exception 项目定义的异常
     */
    default ErrEnum isFalse(boolean expression, Object...obj) throws P21Exception {
        Assert.isFalse(expression,getMessage(),obj);
        return this;
    }

    /**
     * 断言对象为null
     * @param object 判断对象
     * @param obj 异常信息的格式化参数
     * @return 枚举对象本身
     * @throws P21Exception 项目定义的异常
     */
    default ErrEnum isNull(Object object, Object...obj) throws P21Exception {
        Assert.isNull(object,getMessage(),obj);
        return this;
    }

    /**
     * 断言对象不为null
     * @param object 判断对象
     * @param obj 异常信息的格式化参数
     * @return 枚举对象本身
     * @throws P21Exception 项目定义的异常
     */
    default ErrEnum isNotNull(Object object, Object...obj) throws P21Exception {
        Assert.isNotNull(object,getMessage(),obj);
        return this;
    }

    /**
     * 断言这个 字符串 不为 空白字符串
     * 为 empty 则抛异常
     * @param str   字符串
     * @param obj 异常信息的格式化参数
     * @return 枚举对象本身
     * @throws P21Exception 项目定义的异常
     */
    default ErrEnum notBlank(String str, Object...obj) throws P21Exception {
        Assert.notBlank(str,getMessage(),obj);
        return this;
    }

    /**
     * 断言这个 collection 不为 empty
     * @param collection 集合
     * @param obj 异常信息的格式化参数
     * @return 枚举对象本身
     * @throws P21Exception 项目定义的异常
     */
    default ErrEnum notEmpty(Collection collection,  Object...obj) throws P21Exception {
        Assert.notEmpty(collection,getMessage(),obj);
        return this;
    }

    /**
     * 断言这个 Map 不为 empty
     * @param map 集合
     * @param obj 异常信息的格式化参数
     * @return 枚举对象本身
     * @throws P21Exception 项目定义的异常
     */
    default ErrEnum notEmpty(Map map,  Object...obj)throws P21Exception {
        Assert.notEmpty(map,getMessage(),obj);
        return this;
    }

    /**
     * 断言这个 数组 不为 empty
     * @param array   数组
     * @param obj 异常信息的格式化参数
     * @return 枚举对象本身
     * @throws P21Exception 项目定义的异常
     */
    default ErrEnum notEmpty(Object[] array, Object...obj) throws P21Exception {
        Assert.notEmpty(array,getMessage(),obj);
        return this;
    }

    /**
     * 抛出枚举对应的异常
     * @throws P21Exception 异常
     */
    default void throwError() throws P21Exception {
        throw exception();
    }

    /**
     * 抛出枚举对应的异常
     * @param cause 上一层异常
     * @throws P21Exception 异常
     */
    default void throwError(Throwable cause) throws P21Exception {
        throw exception(cause);
    }

    /**
     * 创建异常
     * @param cause 上一层异常
     * @return P21Exception 异常
     */
    default P21Exception exception(Throwable cause){
        return new P21Exception(cause).error(getMessage());
    }

    /**
     * 创建异常
     * @return P21Exception 异常
     */
    default P21Exception exception(){
        return new P21Exception().error(getMessage());
    }


    /**
     * 在原有错误枚举的基础上修改错误信息,这将有可能产生新对象
     * @param msg 新错误信息
     * @return 枚举对象实例
     */
    default ErrEnum resetMsg(String msg){
        return new ExtendErrEnumImpl(getMessage().setMsg(msg));
    }

    /**
     * 格式化错误信息
     * @param obj 格式化参数列表
     * @return 错误信息
     */
    default ErrorMessage format(Object...obj){
        return this.getMessage().format(obj);
    }
}