001/* -*- mode: Java; c-basic-offset: 2; indent-tabs-mode: nil; coding: utf-8-unix -*-
002 *
003 * Copyright © 2017 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.helm;
018
019import java.io.Serializable; // for javadoc only
020
021/**
022 * An abstract {@link RuntimeException} indicating a general Helm- or
023 * Tiller-related problem.
024 *
025 * @author <a href="https://about.me/lairdnelson"
026 * target="_parent">Laird Nelson</a>
027 */
028public abstract class HelmException extends RuntimeException {
029
030
031  /*
032   * Static fields.
033   */
034  
035  
036  /**
037   * The version of this class for {@linkplain Serializable
038   * serialization purposes}.
039   */
040  private static final long serialVersionUID = 1L;
041
042
043  /*
044   * Constructors.
045   */
046  
047
048  /**
049   * Creates a new {@link HelmException}.
050   */
051  protected HelmException() {
052    super();
053  }
054
055  /**
056   * Creates a new {@link HelmException}.
057   *
058   * @param message a descriptive message; may be {@code null}
059   */
060  protected HelmException(final String message) {
061    super(message);
062  }
063
064  /**
065   * Creates a new {@link HelmException}.
066   *
067   * @param cause the {@link Throwable} responsible for this {@link
068   * HelmException}; may be {@code null}
069   */
070  protected HelmException(final Throwable cause) {
071    super(cause);
072  }
073
074  /**
075   * Creates a new {@link HelmException}.
076   *
077   * @param message a descriptive message; may be {@code null}
078   *
079   * @param cause the {@link Throwable} responsible for this {@link
080   * HelmException}; may be {@code null}
081   */
082  protected HelmException(final String message, final Throwable cause) {
083    super(message, cause);
084  }
085  
086}