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.- Author:
- Oliver Burn, lkuehne
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
LocalizedMessage.Utf8Control
Custom ResourceBundle.Control implementation which allows explicitly read the properties files as UTF-8.
-
Constructor Summary
Constructors Constructor Description LocalizedMessage(int lineNo, int columnNo, String bundle, String key, Object[] args, SeverityLevel severityLevel, String moduleId, Class<?> sourceClass, String customMessage)
Creates a newLocalizedMessage
instance.LocalizedMessage(int lineNo, int columnNo, String bundle, String key, Object[] args, String moduleId, Class<?> sourceClass, String customMessage)
Creates a newLocalizedMessage
instance.LocalizedMessage(int lineNo, String bundle, String key, Object[] args, SeverityLevel severityLevel, String moduleId, Class<?> sourceClass, String customMessage)
Creates a newLocalizedMessage
instance.LocalizedMessage(int lineNo, String bundle, String key, Object[] args, String moduleId, Class<?> sourceClass, String customMessage)
Creates a newLocalizedMessage
instance.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static void
clearCache()
Clears the cache.int
compareTo(LocalizedMessage other)
boolean
equals(Object object)
int
getColumnNo()
Gets the column number.String
getKey()
Returns the message key to locate the translation, can also be used in IDE plugins to map error messages to corrective actions.int
getLineNo()
Gets the line number.String
getMessage()
Gets the translated message.String
getModuleId()
Returns id of module.SeverityLevel
getSeverityLevel()
Gets the severity level.String
getSourceName()
Gets the name of the source for this LocalizedMessage.int
hashCode()
static void
setLocale(Locale locale)
Sets a locale to use for localization.
-
-
-
Constructor Detail
-
LocalizedMessage
public LocalizedMessage(int lineNo, int columnNo, String bundle, String key, Object[] args, SeverityLevel severityLevel, String moduleId, Class<?> sourceClass, String customMessage)
Creates a newLocalizedMessage
instance.- Parameters:
lineNo
- line number associated with the messagecolumnNo
- column number associated with the messagebundle
- resource bundle namekey
- the key to locate the translationargs
- arguments for the translationseverityLevel
- severity level for the messagemoduleId
- the id of the module the message is associated withsourceClass
- the Class that is the source of the messagecustomMessage
- 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 newLocalizedMessage
instance.- Parameters:
lineNo
- line number associated with the messagecolumnNo
- column number associated with the messagebundle
- resource bundle namekey
- the key to locate the translationargs
- arguments for the translationmoduleId
- the id of the module the message is associated withsourceClass
- the Class that is the source of the messagecustomMessage
- 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 newLocalizedMessage
instance.- Parameters:
lineNo
- line number associated with the messagebundle
- resource bundle namekey
- the key to locate the translationargs
- arguments for the translationseverityLevel
- severity level for the messagemoduleId
- the id of the module the message is associated withsourceClass
- the source class for the messagecustomMessage
- 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 newLocalizedMessage
instance. The column number defaults to 0.- Parameters:
lineNo
- line number associated with the messagebundle
- name of a resource bundle that contains error messageskey
- the key to locate the translationargs
- arguments for the translationmoduleId
- the id of the module the message is associated withsourceClass
- the name of the source for the messagecustomMessage
- optional custom message overriding the default
-
-
Method Detail
-
clearCache
public static void clearCache()
Clears the cache.
-
getMessage
public String getMessage()
Gets the translated message.- Returns:
- the translated message
-
getLineNo
public int getLineNo()
Gets the line number.- Returns:
- the line number
-
getColumnNo
public int getColumnNo()
Gets the column number.- Returns:
- the column number
-
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 error 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
-
compareTo
public int compareTo(LocalizedMessage other)
- Specified by:
compareTo
in interfaceComparable<LocalizedMessage>
-
-