sirius.kernel.commons

Annotation Type Explain

@Retention(value=CLASS)
public @interface Explain

Can be used in conjuncion with SuppressWarnings to provide an explanation.

This should be used to provide an explanation when findbugs or other inspections are suppressed.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	value Provides a brief explanation why a certain inspection is suppressed.

Element Detail

value

public abstract String value

Provides a brief explanation why a certain inspection is suppressed.

Returns:

the explanation why an inspection is suppressed