org.checkerframework.framework.source

Class Result.DiagMessage

java.lang.Object

org.checkerframework.framework.source.Result.DiagMessage

Enclosing class:

Result

public static class Result.DiagMessage
extends Object

A class that represents diagnostic messages.

DiagMessage encapsulates the message key which would identify the relevant standard error message according to the user locale.

The optional arguments are possible custom strings for the error message.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DiagMessage(@CompilerMessageKey String message, Object[] args)

Method Summary

Modifier and Type	Method and Description
boolean	equals(@Nullable Object obj)
Object[]	getArgs()
@CompilerMessageKey String	getMessageKey()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

DiagMessage

protected DiagMessage(@CompilerMessageKey String message,
                      Object[] args)

Method Detail

getMessageKey

public @CompilerMessageKey String getMessageKey()

Returns:

the message key of this DiagMessage

getArgs

public Object[] getArgs()

Returns:

the customized optional arguments for the message

equals

public boolean equals(@Nullable Object obj)

Overrides:

equals in class Object

hashCode

@Pure
public int hashCode()

Overrides:

hashCode in class Object

toString

@SideEffectFree
public String toString()

Overrides:

toString in class Object