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
021import java.util.Collection; // for javadoc only
022import java.util.Set; // for javadoc only
023
024/**
025 * A {@link SettingsException} indicating that at least one {@link
026 * Value} from a {@link Source} was malformed.
027 *
028 * @author <a href="https://about.me/lairdnelson" target="_parent">Laird Nelson</a>
029 *
030 * @see Settings#handleMalformedValues(String, Set, Collection)
031 */
032public class MalformedValuesException extends SettingsException {
033
034
035  /*
036   * Static fields.
037   */
038
039
040  /**
041   * The version of this class for {@linkplain Serializable
042   * serialization purposes}.
043   */
044  private static final long serialVersionUID = 1L;
045
046
047  /*
048   * Constructors.
049   */
050
051  
052  /**
053   * Creates a new {@link MalformedValuesException}.
054   */
055  public MalformedValuesException() {
056    super();
057  }
058
059  /**
060   * Creates a new {@link MalformedValuesException}.
061   *
062   * @param message a detail message; may be {@code null}
063   */
064  public MalformedValuesException(final String message) {
065    super(message);
066  }
067
068  /**
069   * Creates a new {@link MalformedValuesException}.
070   *
071   * @param cause the {@link Throwable} causing this {@link
072   * MalformedValuesException} to be constructed; may be {@code null}
073   */
074  public MalformedValuesException(final Throwable cause) {
075    super(cause);
076  }
077
078  /**
079   * Creates a new {@link MalformedValuesException}.
080   *
081   * @param message a detail message; may be {@code null}
082   *
083   * @param cause the {@link Throwable} causing this {@link
084   * MalformedValuesException} to be constructed; may be {@code null}
085   */
086  public MalformedValuesException(final String message, final Throwable cause) {
087    super(message, cause);
088  }
089  
090}