net.sf.mmm.util.nls.NlsException Maven / Gradle / Ivy

/* $Id: NlsException.java 402 2008-01-14 21:09:00Z hohwille $
 * Copyright (c) The m-m-m Team, Licensed under the Apache License, Version 2.0
 * http://www.apache.org/licenses/LICENSE-2.0 */
package net.sf.mmm.util.nls;

import net.sf.mmm.util.nls.api.AbstractNlsException;

/**
 * This is an abstract base implementation of a checked exception with real
 * native language support (NLS).

 * ATTENTION:

 * Checked exceptions should be used for business errors and should only occur
 * in unexpected situations.
 * 
 * @see net.sf.mmm.util.nls.api.NlsThrowable
 * 
 * @author Joerg Hohwiller (hohwille at users.sourceforge.net)
 */
public abstract class NlsException extends AbstractNlsException {

  /**
   * The constructor.

   * 
   * @param internationalizedMessage is a short description of the problem. It
   *        is used for
   *        {@link net.sf.mmm.util.nls.api.NlsMessage#getInternationalizedMessage() internationalization}
   *        and should be in English language.
   * @param arguments are the arguments filled into the
   *        internaitionalizedMessage after nationalization. May
   *        be empty if no variable arguments exist.
   */
  public NlsException(String internationalizedMessage, Object... arguments) {

    super(NlsAccess.getFactory().create(internationalizedMessage, arguments));
  }

  /**
   * The constructor.

   * 
   * @param nested is the {@link #getCause() cause} of this exception.
   * @param internationalizedMessage is a short description of the problem. It
   *        is used for
   *        {@link net.sf.mmm.util.nls.api.NlsMessage#getInternationalizedMessage() internationalization}
   *        and should be in English language.
   * @param arguments are the arguments filled into the
   *        internaitionalizedMessage after nationalization. May
   *        be empty if no variable arguments exist.
   */
  public NlsException(Throwable nested, String internationalizedMessage, Object... arguments) {

    super(nested, NlsAccess.getFactory().create(internationalizedMessage, arguments));
  }

}