org.apache.sis.util

Annotation Type Workaround

@Documented
 @Target(value={TYPE,CONSTRUCTOR,METHOD,FIELD,LOCAL_VARIABLE})
 @Retention(value=SOURCE)
public @interface Workaround

Annotates code containing workarounds for bugs or limitations in an external library. This is marker annotation for source code only, in order to keep trace of code to revisit when new versions of external libraries become available.

Usage note: When only a portion of a method contains a workaround and the annotation can not be applied to that specific part, then it is applied to the whole method. Developers need to refer to code comments in order to locate the specific part.

Since:

0.3

Defined in the sis-utility module

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	library A string identifying the library having a bug or limitation.
String	version The last library version on which the bug has been verified.

Element Detail

library

public abstract String library

A string identifying the library having a bug or limitation. Examples: "JDK", "Net­CDF", "JUnit", "SIS".

Returns:

an identifier of the library having a bug or limitation.

version

public abstract String version

The last library version on which the bug has been verified. The bug may have existed before, and may still exist later.

Returns:

the library version on which the bug has been observed.