001/* -*- mode: Java; c-basic-offset: 2; indent-tabs-mode: nil; coding: utf-8-unix -*-
002 *
003 * Copyright © 2023 microBean™.
004 *
005 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
006 * the License.  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 distributed under the License is distributed on
011 * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the License for the
012 * specific language governing permissions and limitations under the License.
013 */
014package org.microbean.reference;
015
016/**
017 * A {@link RuntimeException} thrown to indicate a problem with references.
018 *
019 * @author <a href="https://about.me/lairdnelson/" target="_top">Laird Nelson</a>
020 */
021public class ReferenceException extends RuntimeException {
022
023
024  /*
025   * Static fields.
026   */
027
028
029  /**
030   * The version of this class for {@linkplain java.io.Serializable serialization purposes}.
031   *
032   * @see java.io.Serializable
033   */
034  private static final long serialVersionUID = 1L;
035
036
037  /*
038   * Constructors.
039   */
040
041
042  /**
043   * Creates a new {@link ReferenceException}.
044   *
045   * @see #ReferenceException(String, Throwable)
046   */
047  public ReferenceException() {
048    super();
049  }
050
051  /**
052   * Creates a new {@link ReferenceException}.
053   *
054   * @param message a detail message; may be {@code null}
055   *
056   * @see #ReferenceException(String, Throwable)
057   */
058  public ReferenceException(final String message) {
059    super(message);
060  }
061
062  /**
063   * Creates a new {@link ReferenceException}.
064   *
065   * @param cause a {@link Throwable} that caused the creation of this {@link ReferenceException}; may be {@code null}
066   *
067   * @see #ReferenceException(String, Throwable)
068   */
069  public ReferenceException(final Throwable cause) {
070    super(cause);
071  }
072
073  /**
074   * Creates a new {@link ReferenceException}.
075   *
076   * @param message a detail message; may be {@code null}
077   *
078   * @param cause a {@link Throwable} that caused the creation of this {@link ReferenceException}; may be {@code null}
079   *
080   * @see Throwable#Throwable(String, Throwable)
081   */
082  public ReferenceException(final String message, final Throwable cause) {
083    super(message, cause);
084  }
085
086}