Interface IProblemFactory
- All Known Implementing Classes:
CancelableProblemFactory
,CompletionEngine.CompletionProblemFactory
,DefaultProblemFactory
,ProblemFactory
public interface IProblemFactory
-
Method Summary
Modifier and TypeMethodDescriptioncreateProblem
(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.createProblem
(char[] originatingFileName, int problemId, String[] problemArguments, String[] messageArguments, int severity, int startPosition, int endPosition, int lineNumber, int columnNumber) getLocalizedMessage
(int problemId, int elaborationId, String[] messageArguments) 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.getLocalizedMessage
(int problemId, String[] messageArguments)
-
Method Details
-
createProblem
CategorizedProblem createProblem(char[] originatingFileName, int problemId, String[] problemArguments, String[] messageArguments, int severity, int startPosition, int endPosition, int lineNumber, int columnNumber) -
createProblem
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.- Parameters:
originatingFileName
- the name of the file from which the problem is originatedproblemId
- the problem idproblemArguments
- the fully qualified arguments recorded inside the problemelaborationId
- 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 problemstartPosition
- the start position of the problemendPosition
- the end position of the problemlineNumber
- the line on which the problem occurred- Returns:
- a new IProblem created according to the parameters values.
-
getLocale
Locale getLocale() -
getLocalizedMessage
-
getLocalizedMessage
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.- Parameters:
problemId
- the problem id taken fromIProblem
constantselaborationId
- 0 if the considered problem has no elaboration, a valid elaboration id elsemessageArguments
- the arguments to inject into the template- Returns:
- a localized message elaborated from the supplied problem id, elaboration id and message parameters
-