net.floodlightcontroller.core.annotations
Annotation Type LogMessageDoc

@Target(value={TYPE,METHOD})
public @interface LogMessageDoc

Annotation used to document log messages. This can be used to generate documentation on syslog output.

Author:

readams

Optional Element Summary

java.lang.String	explanation An explanation of the meaning of the log message
java.lang.String	level The log level for the log message
java.lang.String	message The message that will be printed
java.lang.String	recommendation The recommended action associated with the log message

level

public abstract java.lang.String level

The log level for the log message

Returns:

the log level as a string

Default:

"INFO"

message

public abstract java.lang.String message

The message that will be printed

Returns:

the message

Default:

"An unknown error occured"

explanation

public abstract java.lang.String explanation

An explanation of the meaning of the log message

Returns:

the explanation

Default:

"An unknown error occured"

recommendation

public abstract java.lang.String recommendation

The recommended action associated with the log message

Returns:

the recommendation

Default:

"No action is required."