io.rxmicro.common.ImpossibleException Maven / Gradle / Ivy

Go to download

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

The common module with base models and useful utils.

There is a newer version: 0.11

/*
 * 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.common;

import io.rxmicro.common.util.Formats;

/**
 * Indicates that an exception cannot be thrown.
 *
 * 
 * For example:
 * 
 * final ByteArrayOutputStream byteArrayOutputStream = new ByteArrayOutputStream();
 * try (OutputStream out = byteArrayOutputStream) {
 *      // do something
 * } catch (final IOException e) {
 *     throw new ImpossibleException(e, "Writer uses the byte array, so IO exception is impossible!");
 * }
 * 
 *
 * @author nedis
 * @since 0.1
 */
public final class ImpossibleException extends RxMicroException {

    /**
     * Creates a new {@link ImpossibleException} instance with error message.
     *
     * 
     * (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 arguments
     * @throws NullPointerException if the error message template is {@code null}
     * @throws IllegalArgumentException if detected a redundant placeholder or missing argument
     */
    public ImpossibleException(final String message,
                               final Object... args) {
        super(message, args);
    }

    /**
     * Creates a new {@link ImpossibleException} instance with error message and cause.
     *
     * 
     * (FYI: This constructor uses {@link Formats#format(String, Object...)} method to format error message.)
     *
     * @param cause the cause (which is saved for later retrieval by the {@link #getCause()} method).
     * @param message the error message template
     * @param args the error message template arguments
     * @throws NullPointerException if the error message template or cause is {@code null}
     * @throws IllegalArgumentException if detected a redundant placeholder or missing argument
     */
    public ImpossibleException(final Throwable cause,
                               final String message,
                               final Object... args) {
        super(cause, message, args);
    }
}