ConfigurationException.java

/*  
 * Copyright 2008-2014 the original author or authors 
 *
 * 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 org.kaleidofoundry.core.config;

import java.util.Locale;

import org.kaleidofoundry.core.i18n.AbstractI18nRuntimeException;
import org.kaleidofoundry.core.i18n.InternalBundleEnum;
import org.kaleidofoundry.core.lang.annotation.Immutable;

/**
 * <p>
 * Configuration exception is class ancestor for configuration package
 * </p>
 * <p>
 * Warning: this class extends {@link AbstractI18nRuntimeException} and so {@link RuntimeException}. <br/>
 * Any {@link ConfigurationException} will therefore not be trapped by default (directly propagated).<br/>
 * If you want trap explicit configuration errors :
 * </p>
 * 
 * <pre>
 * 	try {
 * 		// handle configuration exception
 *  } catch (ConfigurationException) {
 *  	// specific process
 *  }
 * </pre>
 * 
 * </p>
 * 
 * @author jraduget
 */
@Immutable
public class ConfigurationException extends AbstractI18nRuntimeException {

   private static final long serialVersionUID = 1125414504901L;

   /**
    * @param code
    * @param locale
    * @param args
    */
   public ConfigurationException(final String code, final Locale locale, final String... args) {
	super(code, locale, args);
   }

   /**
    * @param code
    * @param locale
    */
   public ConfigurationException(final String code, final Locale locale) {
	super(code, locale);
   }

   /**
    * @param code
    * @param args
    */
   public ConfigurationException(final String code, final String... args) {
	super(code, args);
   }

   /**
    * @param code
    * @param defaultMsg
    */
   public ConfigurationException(final String code, final String defaultMsg) {
	super(code, defaultMsg);
   }

   /**
    * @param code
    * @param cause
    * @param locale
    * @param args
    */
   public ConfigurationException(final String code, final Throwable cause, final Locale locale, final String... args) {
	super(code, cause, locale, args);
   }

   /**
    * @param code
    * @param cause
    * @param locale
    */
   public ConfigurationException(final String code, final Throwable cause, final Locale locale) {
	super(code, cause, locale);
   }

   /**
    * @param code
    * @param cause
    * @param args
    */
   public ConfigurationException(final String code, final Throwable cause, final String... args) {
	super(code, cause, args);
   }

   /**
    * @param code
    * @param cause
    */
   public ConfigurationException(final String code, final Throwable cause) {
	super(code, cause);
   }

   /**
    * @param code
    */
   public ConfigurationException(final String code) {
	super(code);
   }

   /*
    * (non-Javadoc)
    * @see org.kaleidofoundry.core.i18n.AbstractI18nRuntimeException#getI18nBundleName()
    */
   @Override
   public String getI18nBundleName() {
	return InternalBundleEnum.CONFIGURATION.getResourceName();
   }

}