com.iofairy.except.ConditionsNotMetException Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of functional Show documentation

Functional Programming for Java 8+ and compatible with the modular system of Java 9+.

There is a newer version: 0.5.10

/*
 * Copyright (C) 2021 iofairy, 
 *
 * 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.iofairy.except;


import com.iofairy.si.SI;

/**
 * When the condition is not met, will throw {@code ConditionsNotMetException}. 

 * 条件未满足时抛出此异常
 *
 * @since 0.5.0
 */
public class ConditionsNotMetException extends RuntimeException {

    private static final long serialVersionUID = 999985673658666L;

    /**
     * error code
     */
    protected String code;

    /**
     * Constructs a {@code ConditionsNotMetException} 

     * Examples:
     * {@code
     * try {
     *     throw new ConditionsNotMetException("orderId: ${0}, orderName: ${?}, `orderStatus` must be non-empty! ", 10000, "'order_test'");
     * } catch (Exception e) {
     *     assertEquals("orderId: 10000, orderName: 'order_test', `orderStatus` must be non-empty! ", e.getMessage());
     * }
     *
     * try {
     *     throw new ConditionsNotMetException("userId: ${_}, `phone` must be non-empty! ", 10000);
     * } catch (Exception e) {
     *     assertEquals("userId: 10000, `phone` must be non-empty! ", e.getMessage());
     * }
     *
     * try {
     *     throw new ConditionsNotMetException("userId: ${…}, `phone` must be non-empty! ", 10000);
     * } catch (Exception e) {
     *     assertEquals("userId: 10000, `phone` must be non-empty! ", e.getMessage());
     * }
     *
     * try {
     *     throw new ConditionsNotMetException("`orderStatus` must be non-empty! ");
     * } catch (Exception e) {
     *     assertEquals("`orderStatus` must be non-empty! ", e.getMessage());
     * }
     * }
     *
     * @param msgTemplate message template. It is recommended to use any one of {@code ${0}} or {@code ${?}} or {@code ${…}}
     *                    or {@code ${_}} or meaningful names as placeholders
     * @param args        arguments use to fill placeholder
     */
    public ConditionsNotMetException(String msgTemplate, Object... args) {
        super(getMsg(msgTemplate, args));
    }

    public ConditionsNotMetException(Throwable cause, String msgTemplate, Object... args) {
        super(getMsg(msgTemplate, args), cause);
    }

    public String getCode() {
        return code;
    }

    public ConditionsNotMetException setCode(String code) {
        this.code = code;
        return this;
    }

    private static String getMsg(String msgTemplate, Object... args) {
        if (msgTemplate == null) return null;
        return SI.$(msgTemplate, args);
    }

}