org.checkerframework.framework.source

Class Result

java.lang.Object

org.checkerframework.framework.source.Result

public final class Result
extends java.lang.Object

Represents the outcome of a type-checking operation (success, warning, or failure, plus a list of explanatory messages). Results created during type-checking can be reported using SourceChecker.report(org.checkerframework.framework.source.Result, java.lang.Object), which ultimately delivers an error or warning message via the JSR 199 compiler interface.

See Also:

SourceChecker.report(org.checkerframework.framework.source.Result, java.lang.Object)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Result.DiagMessage A class that represents diagnostic messages.

Field Summary

Fields

Modifier and Type	Field and Description
static Result	SUCCESS The success result.

Method Summary

Modifier and Type	Method and Description
static Result	failure(@CompilerMessageKey java.lang.String messageKey, java.lang.Object... args) Creates a new failure result with the given message key.
java.util.List<Result.DiagMessage>	getDiagMessages()
java.util.List<java.lang.String>	getMessageKeys()
boolean	isFailure()
boolean	isSuccess()
boolean	isWarning()
Result	merge(Result r) Merges two results into one.
java.lang.String	toString()
static Result	warning(@CompilerMessageKey java.lang.String messageKey, java.lang.Object... args) Creates a new warning result with the given message.

Methods inherited from class java.lang.Object

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

Field Detail

SUCCESS

public static final Result SUCCESS

The success result.

Method Detail

failure

public static Result failure(@CompilerMessageKey java.lang.String messageKey,
                             java.lang.Object... args)

Creates a new failure result with the given message key.

Parameters:

messageKey - the key representing the reason for failure

args - optional arguments to be included in the message

Returns:

the failure result

warning

public static Result warning(@CompilerMessageKey java.lang.String messageKey,
                             java.lang.Object... args)

Creates a new warning result with the given message.

Parameters:

messageKey - the key for the warning message

args - optional arguments to be included in the message

Returns:

the warning result

merge

public Result merge(Result r)

Merges two results into one.

Parameters:

r - the result to merge with this result

Returns:

a result that is the success result if both this and r are success results, or a result that has the more significant type (failure > warning > success) and the message keys of both this result and r

isSuccess

public boolean isSuccess()

Returns:

true if the result is success (not a failure or warning)

isFailure

public boolean isFailure()

Returns:

true if the result is a failure

isWarning

public boolean isWarning()

Returns:

true if the result is a warning

getMessageKeys

public java.util.List<java.lang.String> getMessageKeys()

Returns:

the message keys associated with the result

getDiagMessages

public java.util.List<Result.DiagMessage> getDiagMessages()

Returns:

an unmodifiable list of the message pairs

toString

@SideEffectFree
public java.lang.String toString()

Overrides:

toString in class java.lang.Object