001/*
002 * Copyright (C) 2022 - 2024, the original author or authors.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *    http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016package io.github.ascopes.jct.ex;
017
018import org.apiguardian.api.API;
019import org.apiguardian.api.API.Status;
020import org.jspecify.annotations.Nullable;
021
022/**
023 * Exception raised if an illegal input is provided to a method.
024 *
025 * @author Ashley Scopes
026 * @since 1.1.0
027 */
028@API(since = "1.1.0", status = Status.STABLE)
029public final class JctIllegalInputException extends JctException {
030
031  /**
032   * Initialise the exception.
033   *
034   * @param message the message to report.
035   */
036  public JctIllegalInputException(String message) {
037    super(message);
038  }
039
040  /**
041   * Initialise the exception with a cause.
042   *
043   * @param message the message to report.
044   * @param cause   the cause of the exception (or {@code null} if no cause exists).
045   */
046  public JctIllegalInputException(String message, @Nullable Throwable cause) {
047    super(message, cause);
048  }
049}