io.rxmicro.http.error.ValidationException Maven / Gradle / Ivy
/*
* Copyright (c) 2020. https://rxmicro.io
*
* 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 io.rxmicro.http.error;
import io.rxmicro.common.util.Formats;
import static io.rxmicro.common.util.Formats.format;
import static io.rxmicro.common.util.Strings.capitalize;
/**
* A class signaling that the client has sent a {@code Bad Request}.
*
* @author nedis
* @since 0.1
*/
public final class ValidationException extends HttpErrorException {
/**
* Status code for the all instances of the current exception type.
*/
public static final int STATUS_CODE = 400;
/**
* Creates a {@code Bad Request} HTTP error with error message.
*
*
* For all child classes which extend the HttpErrorException class, when creating an exception instance the stack trace is not filled,
* as this information is redundant.
*
*
* (This behavior is achieved by using the {@link RuntimeException#RuntimeException(String, Throwable, boolean, boolean)}.)
*
* @param message the error message
* @throws NullPointerException if the error message is {@code null}
*/
public ValidationException(final String message) {
super(STATUS_CODE, capitalize(message));
}
/**
* Creates a {@code Bad Request} HTTP error with error message.
*
*
* For all child classes which extend the HttpErrorException class, when creating an exception instance the stack trace is not filled,
* as this information is redundant.
*
*
* (This behavior is achieved by using the {@link RuntimeException#RuntimeException(String, Throwable, boolean, boolean)}.)
*
*
* (FYI: This constructor uses {@link Formats#format(String, Object...)} method to format error message.)
*
* @param message the error message template
* @param args the error message template argument
* @throws NullPointerException if the error message template is {@code null}
* @throws IllegalArgumentException if detected a redundant placeholder or missing argument
*/
public ValidationException(final String message,
final Object... args) {
super(STATUS_CODE, capitalize(format(message, args)));
}
}