io.sarl.lang.core.annotation
Annotation InfoOnCall
All Superinterfaces:
java.lang.annotation.Annotation
@java.lang.annotation.Target({TYPE,METHOD,CONSTRUCTOR,FIELD})
@java.lang.annotation.Retention(CLASS)
abstract annotation InfoOnCall
implements java.lang.annotation.Annotation
Annotation for marking an element with a SARL compiler issue than the element is invoked from the SARL code.
Maven Group Identifier:
io.sarl.lang
Maven Artifact Identifier:
core
Since:
0.12
Action Summary
Modifier and type Action and description
abstract boolean error
Replies if the issue is always an error.
abstract boolean info
Replies if the issue is always a warning.
abstract java.lang.String value
Replies the message to provide to the SARL developer.
abstract boolean warning
Replies if the issue is always a warning.
Action Details
error 
def error : boolean
Replies if the issue is always an error. It not, the result of warning() is used.
Returns:
true if it is an error; false if the error level depends on warning() .
See:
warning
info 
def info : boolean
Replies if the issue is always a warning. If one of the functions error() or warning() replies true, the result of this function should be ignored. If this function replies true, the message is an information message. If this function replies false, the message level depends on the user preferences. In this last case, the error level could be "error", "warning", "info", or "ignore"
Returns:
true if it is an information message; false if the error level depends the user preferences.
See:
error , warning
value 
def value : java.lang.String
Replies the message to provide to the SARL developer.
Returns:
the issue message. If empty or null , no issue will be generated by the compiler.
warning 
def warning : boolean
Replies if the issue is always a warning. If the function error() replies true, the result of this function should be ignored. If this function replies true, the message is a warning message. It not, the result of info() is used.
Returns:
true if it is a warning; false if the error level depends on info() .
See:
error , info