////////////////////////////////////////////////////////////////////////////////

 // checkstyle: Checks Java source code for adherence to a set of rules.

 // Copyright (C) 2001-2014  Oliver Burn

 //

 // This library is free software; you can redistribute it and/or

 // modify it under the terms of the GNU Lesser General Public

 // License as published by the Free Software Foundation; either

 // version 2.1 of the License, or (at your option) any later version.

 //

 // This library is distributed in the hope that it will be useful,

 // but WITHOUT ANY WARRANTY; without even the implied warranty of

 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU

 // Lesser General Public License for more details.

 //

 // You should have received a copy of the GNU Lesser General Public

 // License along with this library; if not, write to the Free Software

 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

 ////////////////////////////////////////////////////////////////////////////////

 package com.puppycrawl.tools.checkstyle.api;

 import java.io.Serializable;

 import java.text.MessageFormat;

 import java.util.Arrays;

 import java.util.Collections;

 import java.util.HashMap;

 import java.util.Locale;

 import java.util.Map;

 import java.util.MissingResourceException;

 import java.util.ResourceBundle;

 /**

  * Represents a message that can be localised. The translations come from

  * message.properties files. The underlying implementation uses

  * java.text.MessageFormat.

  *

  * @author Oliver Burn

  * @author lkuehne

  * @version 1.0

  */

 public final class LocalizedMessage

     implements Comparable<LocalizedMessage>, Serializable

 {

     /** Required for serialization. */

     private static final long serialVersionUID = 5675176836184862150L;

     /** hash function multiplicand */

     private static final int HASH_MULT = 29;

     /** the locale to localise messages to **/

     private static Locale sLocale = Locale.getDefault();

     /**

      * A cache that maps bundle names to RessourceBundles.

      * Avoids repetitive calls to ResourceBundle.getBundle().

      * TODO: The cache should be cleared at some point.

      */

     private static final Map<String, ResourceBundle> BUNDLE_CACHE =

         Collections.synchronizedMap(new HashMap<String, ResourceBundle>());

     /** the line number **/

     private final int mLineNo;

     /** the column number **/

     private final int mColNo;

     /** the severity level **/

     private final SeverityLevel mSeverityLevel;

     /** the id of the module generating the message. */

     private final String mModuleId;

     /** the default severity level if one is not specified */

     private static final SeverityLevel DEFAULT_SEVERITY = SeverityLevel.ERROR;

     /** key for the message format **/

     private final String mKey;

     /** arguments for MessageFormat **/

     private final Object[] mArgs;

     /** name of the resource bundle to get messages from **/

     private final String mBundle;

     /** class of the source for this LocalizedMessage */

     private final Class<?> mSourceClass;

     /** a custom message overriding the default message from the bundle. */

     private final String mCustomMessage;

     @Override

     public boolean equals(Object aObject)

     {

         if (this == aObject) {

             return true;

         }

         if (!(aObject instanceof LocalizedMessage)) {

             return false;

         }

         final LocalizedMessage localizedMessage = (LocalizedMessage) aObject;

         if (mColNo != localizedMessage.mColNo) {

             return false;

         }

         if (mLineNo != localizedMessage.mLineNo) {

             return false;

         }

         if (!mKey.equals(localizedMessage.mKey)) {

             return false;

         }

         if (!Arrays.equals(mArgs, localizedMessage.mArgs)) {

             return false;

         }

         // ignoring mBundle for perf reasons.

         // we currently never load the same error from different bundles.

         return true;

     }

     @Override

     public int hashCode()

     {

         int result;

         result = mLineNo;

         result = HASH_MULT * result + mColNo;

         result = HASH_MULT * result + mKey.hashCode();

         for (final Object element : mArgs) {

             result = HASH_MULT * result + element.hashCode();

         }

         return result;

     }

     /**

      * Creates a new <code>LocalizedMessage</code> instance.

      *

      * @param aLineNo line number associated with the message

      * @param aColNo column number associated with the message

      * @param aBundle resource bundle name

      * @param aKey the key to locate the translation

      * @param aArgs arguments for the translation

      * @param aSeverityLevel severity level for the message

      * @param aModuleId the id of the module the message is associated with

      * @param aSourceClass the Class that is the source of the message

      * @param aCustomMessage optional custom message overriding the default

      */

     public LocalizedMessage(int aLineNo,

                             int aColNo,

                             String aBundle,

                             String aKey,

                             Object[] aArgs,

                             SeverityLevel aSeverityLevel,

                             String aModuleId,

                             Class<?> aSourceClass,

                             String aCustomMessage)

     {

         mLineNo = aLineNo;

         mColNo = aColNo;

         mKey = aKey;

         mArgs = (null == aArgs) ? null : aArgs.clone();

         mBundle = aBundle;

         mSeverityLevel = aSeverityLevel;

         mModuleId = aModuleId;

         mSourceClass = aSourceClass;

         mCustomMessage = aCustomMessage;

     }

     /**

      * Creates a new <code>LocalizedMessage</code> instance.

      *

      * @param aLineNo line number associated with the message

      * @param aColNo column number associated with the message

      * @param aBundle resource bundle name

      * @param aKey the key to locate the translation

      * @param aArgs arguments for the translation

      * @param aModuleId the id of the module the message is associated with

      * @param aSourceClass the Class that is the source of the message

      * @param aCustomMessage optional custom message overriding the default

      */

     public LocalizedMessage(int aLineNo,

                             int aColNo,

                             String aBundle,

                             String aKey,

                             Object[] aArgs,

                             String aModuleId,

                             Class<?> aSourceClass,

                             String aCustomMessage)

     {

         this(aLineNo,

              aColNo,

              aBundle,

              aKey,

              aArgs,

              DEFAULT_SEVERITY,

              aModuleId,

              aSourceClass,

              aCustomMessage);

     }

     /**

      * Creates a new <code>LocalizedMessage</code> instance.

      *

      * @param aLineNo line number associated with the message

      * @param aBundle resource bundle name

      * @param aKey the key to locate the translation

      * @param aArgs arguments for the translation

      * @param aSeverityLevel severity level for the message

      * @param aModuleId the id of the module the message is associated with

      * @param aSourceClass the source class for the message

      * @param aCustomMessage optional custom message overriding the default

      */

     public LocalizedMessage(int aLineNo,

                             String aBundle,

                             String aKey,

                             Object[] aArgs,

                             SeverityLevel aSeverityLevel,

                             String aModuleId,

                             Class<?> aSourceClass,

                             String aCustomMessage)

     {

         this(aLineNo, 0, aBundle, aKey, aArgs, aSeverityLevel, aModuleId,

                 aSourceClass, aCustomMessage);

     }

     /**

      * Creates a new <code>LocalizedMessage</code> instance. The column number

      * defaults to 0.

      *

      * @param aLineNo line number associated with the message

      * @param aBundle name of a resource bundle that contains error messages

      * @param aKey the key to locate the translation

      * @param aArgs arguments for the translation

      * @param aModuleId the id of the module the message is associated with

      * @param aSourceClass the name of the source for the message

      * @param aCustomMessage optional custom message overriding the default

      */

     public LocalizedMessage(

         int aLineNo,

         String aBundle,

         String aKey,

         Object[] aArgs,

         String aModuleId,

         Class<?> aSourceClass,

         String aCustomMessage)

     {

         this(aLineNo, 0, aBundle, aKey, aArgs, DEFAULT_SEVERITY, aModuleId,

                 aSourceClass, aCustomMessage);

     }

     /** @return the translated message **/

     public String getMessage()

     {

         final String customMessage = getCustomMessage();

         if (customMessage != null) {

             return customMessage;

         }

         try {

             // Important to use the default class loader, and not the one in

             // the GlobalProperties object. This is because the class loader in

             // the GlobalProperties is specified by the user for resolving

             // custom classes.

             final ResourceBundle bundle = getBundle(mBundle);

             final String pattern = bundle.getString(mKey);

             return MessageFormat.format(pattern, mArgs);

         }

         catch (final MissingResourceException ex) {

             // If the Check author didn't provide i18n resource bundles

             // and logs error messages directly, this will return

             // the author's original message

             return MessageFormat.format(mKey, mArgs);

         }

     }

     /**

      * Returns the formatted custom message if one is configured.

      * @return the formatted custom message or <code>null</code>

      *          if there is no custom message

      */

     private String getCustomMessage()

     {

         if (mCustomMessage == null) {

             return null;

         }

         return MessageFormat.format(mCustomMessage, mArgs);

     }

     /**

      * Find a ResourceBundle for a given bundle name. Uses the classloader

      * of the class emitting this message, to be sure to get the correct

      * bundle.

      * @param aBundleName the bundle name

      * @return a ResourceBundle

      */

     private ResourceBundle getBundle(String aBundleName)

     {

         synchronized (BUNDLE_CACHE) {

             ResourceBundle bundle = BUNDLE_CACHE

                     .get(aBundleName);

             if (bundle == null) {

                 bundle = ResourceBundle.getBundle(aBundleName, sLocale,

                         mSourceClass.getClassLoader());

                 BUNDLE_CACHE.put(aBundleName, bundle);

             }

             return bundle;

         }

     }

     /** @return the line number **/

     public int getLineNo()

     {

         return mLineNo;

     }

     /** @return the column number **/

     public int getColumnNo()

     {

         return mColNo;

     }

     /** @return the severity level **/

     public SeverityLevel getSeverityLevel()

     {

         return mSeverityLevel;

     }

     /** @return the module identifier. */

     public String getModuleId()

     {

         return mModuleId;

     }

     /**

      * Returns the message key to locate the translation, can also be used

      * in IDE plugins to map error messages to corrective actions.

      *

      * @return the message key

      */

     public String getKey()

     {

         return mKey;

     }

     /** @return the name of the source for this LocalizedMessage */

     public String getSourceName()

     {

         return mSourceClass.getName();

     }

     /** @param aLocale the locale to use for localization **/

     public static void setLocale(Locale aLocale)

     {

         sLocale = aLocale;

     }

     ////////////////////////////////////////////////////////////////////////////

     // Interface Comparable methods

     ////////////////////////////////////////////////////////////////////////////

     /** {@inheritDoc} */

     public int compareTo(LocalizedMessage aOther)

     {

         if (getLineNo() == aOther.getLineNo()) {

             if (getColumnNo() == aOther.getColumnNo()) {

                 return getMessage().compareTo(aOther.getMessage());

             }

             return (getColumnNo() < aOther.getColumnNo()) ? -1 : 1;

         }

         return (getLineNo() < aOther.getLineNo()) ? -1 : 1;

     }

 }