Class LocalizedMessage

java.lang.Object
com.puppycrawl.tools.checkstyle.api.LocalizedMessage
All Implemented Interfaces:
Serializable, Comparable<LocalizedMessage>

public final class LocalizedMessage extends Object implements Comparable<LocalizedMessage>, Serializable
Represents a message that can be localised. The translations come from message.properties files. The underlying implementation uses java.text.MessageFormat.
See Also:
  • Constructor Details

    • LocalizedMessage

      public LocalizedMessage(int lineNo, int columnNo, int columnCharIndex, int tokenType, String bundle, String key, Object[] args, SeverityLevel severityLevel, String moduleId, Class<?> sourceClass, String customMessage)
      Creates a new LocalizedMessage instance.
      Parameters:
      lineNo - line number associated with the message
      columnNo - column number associated with the message
      columnCharIndex - column char index associated with the message
      tokenType - token type of the event associated with the message. See TokenTypes
      bundle - resource bundle name
      key - the key to locate the translation
      args - arguments for the translation
      severityLevel - severity level for the message
      moduleId - the id of the module the message is associated with
      sourceClass - the Class that is the source of the message
      customMessage - optional custom message overriding the default
    • LocalizedMessage

      public LocalizedMessage(int lineNo, int columnNo, int tokenType, String bundle, String key, Object[] args, SeverityLevel severityLevel, String moduleId, Class<?> sourceClass, String customMessage)
      Creates a new LocalizedMessage instance.
      Parameters:
      lineNo - line number associated with the message
      columnNo - column number associated with the message
      tokenType - token type of the event associated with the message. See TokenTypes
      bundle - resource bundle name
      key - the key to locate the translation
      args - arguments for the translation
      severityLevel - severity level for the message
      moduleId - the id of the module the message is associated with
      sourceClass - the Class that is the source of the message
      customMessage - optional custom message overriding the default
    • LocalizedMessage

      public LocalizedMessage(int lineNo, int columnNo, String bundle, String key, Object[] args, SeverityLevel severityLevel, String moduleId, Class<?> sourceClass, String customMessage)
      Creates a new LocalizedMessage instance.
      Parameters:
      lineNo - line number associated with the message
      columnNo - column number associated with the message
      bundle - resource bundle name
      key - the key to locate the translation
      args - arguments for the translation
      severityLevel - severity level for the message
      moduleId - the id of the module the message is associated with
      sourceClass - the Class that is the source of the message
      customMessage - optional custom message overriding the default
    • LocalizedMessage

      public LocalizedMessage(int lineNo, int columnNo, String bundle, String key, Object[] args, String moduleId, Class<?> sourceClass, String customMessage)
      Creates a new LocalizedMessage instance.
      Parameters:
      lineNo - line number associated with the message
      columnNo - column number associated with the message
      bundle - resource bundle name
      key - the key to locate the translation
      args - arguments for the translation
      moduleId - the id of the module the message is associated with
      sourceClass - the Class that is the source of the message
      customMessage - optional custom message overriding the default
    • LocalizedMessage

      public LocalizedMessage(int lineNo, String bundle, String key, Object[] args, SeverityLevel severityLevel, String moduleId, Class<?> sourceClass, String customMessage)
      Creates a new LocalizedMessage instance.
      Parameters:
      lineNo - line number associated with the message
      bundle - resource bundle name
      key - the key to locate the translation
      args - arguments for the translation
      severityLevel - severity level for the message
      moduleId - the id of the module the message is associated with
      sourceClass - the source class for the message
      customMessage - optional custom message overriding the default
    • LocalizedMessage

      public LocalizedMessage(int lineNo, String bundle, String key, Object[] args, String moduleId, Class<?> sourceClass, String customMessage)
      Creates a new LocalizedMessage instance. The column number defaults to 0.
      Parameters:
      lineNo - line number associated with the message
      bundle - name of a resource bundle that contains audit event messages
      key - the key to locate the translation
      args - arguments for the translation
      moduleId - the id of the module the message is associated with
      sourceClass - the name of the source for the message
      customMessage - optional custom message overriding the default
  • Method Details

    • getLineNo

      public int getLineNo()
      Gets the line number.
      Returns:
      the line number
    • getColumnNo

      public int getColumnNo()
      Gets the column number.
      Returns:
      the column number
    • getColumnCharIndex

      public int getColumnCharIndex()
      Gets the column char index.
      Returns:
      the column char index
    • getTokenType

      public int getTokenType()
      Gets the token type.
      Returns:
      the token type
    • getSeverityLevel

      public SeverityLevel getSeverityLevel()
      Gets the severity level.
      Returns:
      the severity level
    • getModuleId

      public String getModuleId()
      Returns id of module.
      Returns:
      the module identifier.
    • getKey

      public String getKey()
      Returns the message key to locate the translation, can also be used in IDE plugins to map audit event messages to corrective actions.
      Returns:
      the message key
    • getSourceName

      public String getSourceName()
      Gets the name of the source for this LocalizedMessage.
      Returns:
      the name of the source for this LocalizedMessage
    • setLocale

      public static void setLocale(Locale locale)
      Sets a locale to use for localization.
      Parameters:
      locale - the locale to use for localization
    • clearCache

      public static void clearCache()
      Clears the cache.
    • equals

      public boolean equals(Object object)
      Indicates whether some other object is "equal to" this one. Suppression on enumeration is needed so code stays consistent.
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • compareTo

      public int compareTo(LocalizedMessage other)
      Specified by:
      compareTo in interface Comparable<LocalizedMessage>
    • getMessage

      public String getMessage()
      Gets the translated message.
      Returns:
      the translated message