de.smartics.maven.plugin.jboss.modules.util.BlankExceptNullArgumentException Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2013-2017 smartics, Kronseder & Reiner GmbH
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package de.smartics.maven.plugin.jboss.modules.util;

/**
 * Signals that a given {@link String} argument is not null but
 * contains only whitespaces or is empty.
 */
public class BlankExceptNullArgumentException extends IllegalArgumentException
{
  // ********************************* Fields *********************************

  // --- constants ------------------------------------------------------------

  /**
   * The class version identifier.
   * 
   * The value of this constant is {@value}.
   * 
   */
  private static final long serialVersionUID = 1L;

  // --- members --------------------------------------------------------------

  // ****************************** Initializer *******************************

  // ****************************** Constructors ******************************

  /**
   * Convenience constructor if no argument name needs to be provided. This
   * constructor is not recommended since the exception's message is less
   * verbose.
   */
  public BlankExceptNullArgumentException()
  {
    this(null);
  }

  /**
   * Convenience constructor.
   *
   * @param argName the name of the {@link String} argument that contains only
   *          whitespaces or was empty.
   */
  public BlankExceptNullArgumentException(final String argName)
  {
    this(argName, null);
  }

  /**
   * Default constructor.
   *
   * @param argName the name of the {@link String} argument that contains only
   *          whitespaces or was empty.
   * @param message an optional additional message to provide information about
   *          the context of the argument.
   * @see java.lang.IllegalArgumentException#IllegalArgumentException(java.lang.String)
   */
  public BlankExceptNullArgumentException(final String argName, final String message)
  {
    super((argName == null ? "Argument" : argName)
          + " must not contain only whitespace or be empty"
          + (message != null ? ": " + message : "."));
  }

  // ****************************** Inner Classes *****************************

  // ********************************* Methods ********************************

  // --- init -----------------------------------------------------------------

  // --- get&set --------------------------------------------------------------

  // --- business -------------------------------------------------------------

  // --- object basics --------------------------------------------------------

}