/*

  * Licensed to the Apache Software Foundation (ASF) under one or more

  * contributor license agreements.  See the NOTICE file distributed with

  * this work for additional information regarding copyright ownership.

  * The ASF licenses this file to You 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.apache.commons.nabla;

 import java.util.Locale;

 import java.util.MissingResourceException;

 import java.util.ResourceBundle;

 import org.apache.commons.math3.exception.util.Localizable;

 /**

  * Enumeration for localized messages formats used in exceptions messages.

  * <p>

  * The constants in this enumeration represent the available

  * formats as localized strings. These formats are intended to be

  * localized using simple properties files, using the constant

  * name as the key and the property value as the message format.

  * The source English format is provided in the constants themselves

  * to serve both as a reminder for developers to understand the parameters

  * needed by each format, as a basis for translators to create

  * localized properties files, and as a default format if some

  * translation is missing.

  * </p>

  * @version $Id$

  */

 public enum NablaMessages implements Localizable {

     // CHECKSTYLE: stop MultipleVariableDeclarations

     // CHECKSTYLE: stop JavadocVariable

     CANNOT_READ_CLASS("class {0} cannot be read ({1})"),

     CANNOT_INSTANTIATE_ABSTRACT_CLASS("abstract class {0} cannot be instantiated ({1})"),

     ILLEGAL_ACCESS_TO_CONSTRUCTOR("illegal access to class {0} constructor ({1})"),

     CANNOT_BUILD_CLASS_FROM_OTHER_CLASS("class {0} cannot be built from an instance of class {1} ({2})"),

     CANNOT_INSTANTIATE_CLASS_FROM_OTHER_INSTANCE("class {0} instantiation from an instance of class {1} failed ({2})"),

     INCORRECT_GENERATED_CODE("class {0} code generated from an instance of class {1} is incorrect ({2})"),

     INTERFACE_NOT_FOUND_WHILE_DIFFERENTIATING("interface {0} not found while differentiating class {1}"),

     CLASS_DOES_NOT_IMPLEMENT_INTERFACE("the {0} class does not implement the {1} interface"),

     UNABLE_TO_ANALYZE_METHOD("unable to analyze the {0}.{1} method ({2})"),

     UNKNOWN_METHOD("unknown method {0}.{1}"),

     NUMBER_OF_TEMPORARY_VARIABLES_OUT_OF_RANGE("number of temporary variable ({0}) outside of [{1}, {2}] range"),

     INDEX_OF_LOCAL_VARIABLE_OUT_OF_RANGE("index of size {0} local variable ({1}) outside of [{2}, {3}] range"),

     UNEXPECTED_INSTRUCTION("unexpected instruction with opcode {0}"),

     UNABLE_TO_HANDLE_INSTRUCTION("unable to handle instruction with opcode {0}"),

     CANNOT_GET_VOID_FIELD("unable to get value of void type field {0}"),

     ILLEGAL_LDC_CONSTANT("illegal LDC constant {0}"),

     INTERNAL_ERROR("internal error, please fill a bug report at {0}");

     // CHECKSTYLE: resume JavadocVariable

     // CHECKSTYLE: resume MultipleVariableDeclarations

     /** Source English format. */

     private final String sourceFormat;

     /** Simple constructor.

      * @param sourceFormat source English format to use when no

      * localized version is available

      */

     private NablaMessages(final String sourceFormat) {

         this.sourceFormat = sourceFormat;

     }

     /** {@inheritDoc} */

     public String getSourceString() {

         return sourceFormat;

     }

     /** {@inheritDoc} */

     public String getLocalizedString(final Locale locale) {

         try {

             final String path = NablaMessages.class.getName().replaceAll("\\.", "/");

             final ResourceBundle bundle =

                     ResourceBundle.getBundle("assets/" + path, locale);

             if (bundle.getLocale().getLanguage().equals(locale.getLanguage())) {

                 // the value of the resource is the translated format

                 return bundle.getString(toString());

             }

         } catch (MissingResourceException mre) {

             // do nothing here

         }

         // either the locale is not supported or the resource is unknown

         // don't translate and fall back to using the source format

         return sourceFormat;

     }

 }