net.grinder.console.common.DisplayMessageConsoleException Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of grinder-core Show documentation
The Grinder.
The newest version!
// Copyright (C) 2000, 2001, 2002, 2003 Philip Aston
// All rights reserved.
//
// This file is part of The Grinder software distribution. Refer to
// the file LICENSE which is part of The Grinder distribution for
// licensing details. The Grinder distribution is available on the
// Internet at http://grinder.sourceforge.net/
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
// FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
// COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
// INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
// (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
// SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
// HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
// STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
// OF THE POSSIBILITY OF SUCH DAMAGE.

package net.grinder.console.common;

import java.text.MessageFormat;


/**
 * Exception that can be displayed through the user interface.
 * Supports internationalised text through {@link Resources}.
 *
 * @author Philip Aston
 */
public class DisplayMessageConsoleException extends ConsoleException {

  /**
   * Constructor.
   *
   * @param resources Resources to use.
   * @param resourceKey Resource key that specifies message.
   */
  public DisplayMessageConsoleException(Resources resources,
                                        String resourceKey) {
    super(getMessage(resources, resourceKey));
  }

  /**
   * Constructor.
   *
   * @param resources Resources to use.
   * @param resourceKey Resource key that specifies message.
   * @param e Nested exception.
   */
  public DisplayMessageConsoleException(Resources resources,
                                        String resourceKey,
                                        Exception e) {
    super(getMessage(resources, resourceKey), e);
  }

  /**
   * Constructor.
   *
   * @param resources Resources to use.
   * @param resourceKey Resource key that specifies message.
   * @param arguments Message arguments.
   */
  public DisplayMessageConsoleException(Resources resources,
                                        String resourceKey,
                                        Object[] arguments) {
    super(MessageFormat.format(getMessage(resources, resourceKey), arguments));
  }

  /**
   * Constructor.
   *
   * @param resources Resources to use.
   * @param resourceKey Resource key that specifies message.
   * @param arguments Message arguments.
   * @param e Nested exception.
   */
  public DisplayMessageConsoleException(Resources resources,
                                        String resourceKey,
                                        Object[] arguments,
                                        Exception e) {
    super(MessageFormat.format(getMessage(resources, resourceKey), arguments),
          e);
  }

  private static String getMessage(Resources resources, String resourceKey) {

    final String resourceValue = resources.getString(resourceKey, false);

    if (resourceValue != null) {
      return resourceValue;
    }
    else {
      return "No message found for key \"" + resourceKey + "\"";
    }
  }
}