com.puppycrawl.tools.checkstyle.api

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.

Version:

1.0

Author:

Oliver Burn, lkuehne

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
LocalizedMessage(int lineNo, int colNo, String bundle, String key, Object[] args, SeverityLevel severityLevel, String moduleId, Class<?> sourceClass, String customMessage) Creates a new LocalizedMessage instance.
LocalizedMessage(int lineNo, int colNo, String bundle, String key, Object[] args, String moduleId, Class<?> sourceClass, String customMessage) Creates a new LocalizedMessage instance.
LocalizedMessage(int lineNo, String bundle, String key, Object[] args, SeverityLevel severityLevel, String moduleId, Class<?> sourceClass, String customMessage) Creates a new LocalizedMessage instance.
LocalizedMessage(int lineNo, String bundle, String key, Object[] args, String moduleId, Class<?> sourceClass, String customMessage) Creates a new LocalizedMessage instance.

Method Summary

Methods

Modifier and Type	Method and Description
static void	clearCache() Clears the cache.
int	compareTo(LocalizedMessage other)
boolean	equals(Object object)
int	getColumnNo()
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()
String	getMessage()
String	getModuleId()
SeverityLevel	getSeverityLevel()
String	getSourceName()
int	hashCode()
static void	setLocale(Locale locale)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LocalizedMessage

public LocalizedMessage(int lineNo,
                int colNo,
                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

colNo - 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 colNo,
                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

colNo - 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 error 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 Detail

equals

public boolean equals(Object object)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clearCache

public static void clearCache()

Clears the cache.

getMessage

public String getMessage()

Returns:

the translated message

getLineNo

public int getLineNo()

Returns:

the line number

getColumnNo

public int getColumnNo()

Returns:

the column number

getSeverityLevel

public SeverityLevel getSeverityLevel()

Returns:

the severity level

getModuleId

public String getModuleId()

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()

Returns:

the name of the source for this LocalizedMessage

setLocale

public static void setLocale(Locale locale)

Parameters:

locale - the locale to use for localization

compareTo

public int compareTo(LocalizedMessage other)

Specified by:

compareTo in interface Comparable<LocalizedMessage>