org.eclipse.jdt.internal.compiler.problem

Class DefaultProblemFactory

java.lang.Object

org.eclipse.jdt.internal.compiler.problem.DefaultProblemFactory

All Implemented Interfaces:

IProblemFactory

public class DefaultProblemFactory
extends Object
implements IProblemFactory

Field Summary

Fields

Modifier and Type	Field and Description
HashtableOfInt	messageTemplates

Constructor Summary

Constructors

Constructor and Description
DefaultProblemFactory()
DefaultProblemFactory(Locale loc)

Method Summary

Methods

Modifier and Type	Method and Description
CategorizedProblem	createProblem(char[] originatingFileName, int problemId, String[] problemArguments, int elaborationId, String[] messageArguments, int severity, int startPosition, int endPosition, int lineNumber, int columnNumber) Answer a new IProblem created according to the parameters values.
CategorizedProblem	createProblem(char[] originatingFileName, int problemId, String[] problemArguments, String[] messageArguments, int severity, int startPosition, int endPosition, int lineNumber, int columnNumber) Answer a new IProblem created according to the parameters value originatingFileName the name of the file name from which the problem is originated problemId the problem id problemArguments the fully qualified arguments recorded inside the problem messageArguments the arguments needed to set the error message (shorter names than problemArguments ones) severity the severity of the problem startPosition the starting position of the problem endPosition the end position of the problem lineNumber the line on which the problem occured
Locale	getLocale() Answer the locale used to retrieve the error messages
String	getLocalizedMessage(int id, int elaborationId, String[] problemArguments) Inject the supplied message arguments into a localized template elaborated from the supplied problem id and an optional elaboration id and return the resulting message.
String	getLocalizedMessage(int id, String[] problemArguments)
static HashtableOfInt	loadMessageTemplates(Locale loc) This method initializes the MessageTemplates class variable according to the current Locale.
String	localizedMessage(CategorizedProblem problem)
void	setLocale(Locale locale)

Methods inherited from class java.lang.Object

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

Field Detail

messageTemplates

public HashtableOfInt messageTemplates

Constructor Detail

DefaultProblemFactory

public DefaultProblemFactory()

DefaultProblemFactory

public DefaultProblemFactory(Locale loc)

Parameters:

loc - the locale used to get the right message

Method Detail

createProblem

public CategorizedProblem createProblem(char[] originatingFileName,
                               int problemId,
                               String[] problemArguments,
                               String[] messageArguments,
                               int severity,
                               int startPosition,
                               int endPosition,
                               int lineNumber,
                               int columnNumber)

Answer a new IProblem created according to the parameters value

• originatingFileName the name of the file name from which the problem is originated
• problemId the problem id
• problemArguments the fully qualified arguments recorded inside the problem
• messageArguments the arguments needed to set the error message (shorter names than problemArguments ones)
• severity the severity of the problem
• startPosition the starting position of the problem
• endPosition the end position of the problem
• lineNumber the line on which the problem occured

Specified by:

createProblem in interface IProblemFactory

Parameters:

originatingFileName - char[]

problemId - int

problemArguments - String[]

messageArguments - String[]

severity - int

startPosition - int

endPosition - int

lineNumber - int

Returns:

CategorizedProblem

createProblem

public CategorizedProblem createProblem(char[] originatingFileName,
                               int problemId,
                               String[] problemArguments,
                               int elaborationId,
                               String[] messageArguments,
                               int severity,
                               int startPosition,
                               int endPosition,
                               int lineNumber,
                               int columnNumber)

Description copied from interface: IProblemFactory

Answer a new IProblem created according to the parameters values.

Specified by:

createProblem in interface IProblemFactory

Parameters:

originatingFileName - the name of the file from which the problem is originated

problemId - the problem id

problemArguments - the fully qualified arguments recorded inside the problem

elaborationId - the message elaboration id (0 for problems that have no message elaboration)

messageArguments - the arguments needed to set the error message (shorter names than problemArguments ones)

severity - the severity of the problem

startPosition - the start position of the problem

endPosition - the end position of the problem

lineNumber - the line on which the problem occurred

Returns:

a new IProblem created according to the parameters values.

getLocale

public Locale getLocale()

Answer the locale used to retrieve the error messages

Specified by:

getLocale in interface IProblemFactory

Returns:

java.util.Locale

setLocale

public void setLocale(Locale locale)

getLocalizedMessage

public final String getLocalizedMessage(int id,
                         String[] problemArguments)

Specified by:

getLocalizedMessage in interface IProblemFactory

getLocalizedMessage

public final String getLocalizedMessage(int id,
                         int elaborationId,
                         String[] problemArguments)

Description copied from interface: IProblemFactory

Inject the supplied message arguments into a localized template elaborated from the supplied problem id and an optional elaboration id and return the resulting message. The arguments number should match the highest placeholder index in the template. When an elaboration id is used, the template matching that elaboration id replaces '{0}' into the template matching the problem id before the message arguments are injected.

Specified by:

getLocalizedMessage in interface IProblemFactory

Parameters:

id - the problem id taken from IProblem constants

elaborationId - 0 if the considered problem has no elaboration, a valid elaboration id else

problemArguments - the arguments to inject into the template

Returns:

a localized message elaborated from the supplied problem id, elaboration id and message parameters

localizedMessage

public final String localizedMessage(CategorizedProblem problem)

Parameters:

problem - CategorizedProblem

Returns:

String

loadMessageTemplates

public static HashtableOfInt loadMessageTemplates(Locale loc)

This method initializes the MessageTemplates class variable according to the current Locale.

Parameters:

loc - Locale

Returns:

HashtableOfInt