io.sarl.lang.annotation

Annotation Type InfoOnCall

@Target(value={TYPE,METHOD,CONSTRUCTOR,FIELD})
 @Retention(value=CLASS)
public @interface InfoOnCall

Annotation for marking an element with a SARL compiler issue than the element is invoked from the SARL code.

Since:

0.12

Version:

io.sarl.lang.core 0.12.0 20210527-171007

Author:

Stéphane Galland

Maven Group Id:

io.sarl.lang

Maven Artifact Id:

io.sarl.lang.core

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	value Replies the message to provide to the SARL developer.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	error Replies if the issue is always an error.
boolean	info Replies if the issue is always a warning.
boolean	warning Replies if the issue is always a warning.

Element Detail

value

public abstract String value

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.

error

public abstract boolean error

Replies if the issue is always an error. It not, the result of InfoOnCall.warning() is used.

Returns:

true if it is an error; false if the error level depends on InfoOnCall.warning().

See Also:

InfoOnCall.warning()

Default:

false

warning

public abstract boolean warning

Replies if the issue is always a warning. If the function InfoOnCall.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 InfoOnCall.info() is used.

Returns:

true if it is a warning; false if the error level depends on InfoOnCall.info().

See Also:

InfoOnCall.error(), InfoOnCall.info()

Default:

false

info

public abstract boolean info

Replies if the issue is always a warning. If one of the functions InfoOnCall.error() or InfoOnCall.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 Also:

InfoOnCall.error(), InfoOnCall.warning()

Default:

false