org.wpilib.annotation.NoDiscard Interface Reference

Public Member Functions
String	value () default ""

Public Attributes
String	SUPPRESSION_KEY = "WPILib.NoDiscard"

Detailed Description

Marks a method as returning a value that must be used. The WPILib compiler plugin will check for uses of methods with this annotation and report a compiler error if the value is unused. Marking a class or interface as @NoDiscard will act as if any method that returns that type or any subclass or implementor of that type has been marked with @NoDiscard.

Definition at line 20 of file NoDiscard.java.

Member Function Documentation

value()

String org.wpilib.annotation.NoDiscard.value

(

)

An error message to display if the return value is not used.

Returns

The error message.

Member Data Documentation

SUPPRESSION_KEY

String org.wpilib.annotation.NoDiscard.SUPPRESSION_KEY = "WPILib.NoDiscard"

The string key to use in SuppressWarnings annotations to suppress compiler error messages related to this annotation.

Definition at line 25 of file NoDiscard.java.

---

The documentation for this interface was generated from the following file:

• org/wpilib/annotation/NoDiscard.java