001/* -*- mode: Java; c-basic-offset: 2; indent-tabs-mode: nil; coding: utf-8-unix -*-
002 *
003 * Copyright © 2020 microBean™.
004 *
005 * Licensed under the Apache License, Version 2.0 (the "License");
006 * you may not use this file except in compliance with the License.
007 * You may obtain a copy of the License at
008 *
009 *     http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
014 * implied.  See the License for the specific language governing
015 * permissions and limitations under the License.
016 */
017package org.microbean.settings;
018
019import java.io.Serializable; // for javadoc only
020
021/**
022 * A {@link RuntimeException} indicating a problem with an operation
023 * from, most likely, a {@link Settings} instance.
024 *
025 * @author <a href="https://about.me/lairdnelson"
026 * target="_parent">Laird Nelson</a>
027 *
028 * @see Settings
029 */
030public class SettingsException extends RuntimeException {
031
032
033  /*
034   * Static fields.
035   */
036
037
038  /**
039   * The version of this class for {@linkplain Serializable
040   * serialization purposes}.
041   */
042  private static final long serialVersionUID = 1L;
043
044
045  /*
046   * Constructors.
047   */
048
049
050  /**
051   * Creates a new {@link SettingsException}.
052   */
053  public SettingsException() {
054    super();
055  }
056
057  /**
058   * Creates a new {@link SettingsException}.
059   *
060   * @param message a detail message; may be {@code null}
061   */
062  public SettingsException(final String message) {
063    super(message);
064  }
065
066  /**
067   * Creates a new {@link SettingsException}.
068   *
069   * @param cause the {@link Throwable} causing this {@link
070   * SettingsException} to be constructed; may be {@code null}
071   */
072  public SettingsException(final Throwable cause) {
073    super(cause);
074  }
075
076  /**
077   * Creates a new {@link SettingsException}.
078   *
079   * @param message a detail message; may be {@code null}
080   *
081   * @param cause the {@link Throwable} causing this {@link
082   * SettingsException} to be constructed; may be {@code null}
083   */
084  public SettingsException(final String message, final Throwable cause) {
085    super(message, cause);
086  }
087
088}