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

Go to download
/*
 * 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;

/**
 * No variable was found during string interpolation, will throw {@code UndefinedVariableException}. 

 * 字符串插值时，未找到对应的变量，则抛出此异常
 *
 * @since 0.4.0
 */
public class UndefinedVariableException extends BaseRuntimeException {
    private static final long serialVersionUID = 656057295L;


    /**
     * Constructs an {@code UndefinedVariableException} with {@code null}
     * as its error detail message.
     */
    public UndefinedVariableException() {
        super();
    }

    /**
     * Constructs a {@code UndefinedVariableException} 

     * Examples:
     * {@code
     * try {
     *     throw new UndefinedVariableException("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 UndefinedVariableException("userId: ${_}, `phone` must be non-empty! ", 10000);
     * } catch (Exception e) {
     *     assertEquals("userId: 10000, `phone` must be non-empty! ", e.getMessage());
     * }
     *
     * try {
     *     throw new UndefinedVariableException("userId: ${…}, `phone` must be non-empty! ", 10000);
     * } catch (Exception e) {
     *     assertEquals("userId: 10000, `phone` must be non-empty! ", e.getMessage());
     * }
     *
     * try {
     *     throw new UndefinedVariableException("`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 UndefinedVariableException(String msgTemplate, Object... args) {
        super(msgTemplate, args);
    }

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

    public UndefinedVariableException(Throwable cause) {
        super(cause);
    }

    @Override
    public UndefinedVariableException setCode(String code) {
        this.code = code;
        return this;
    }
}