doc/manual/annotations.html - Issue 1232833004: Update findbugs from 3.0.0 to 3.0.1.

Unified Diff: doc/manual/annotations.html

Issue 1232833004: Update findbugs from 3.0.0 to 3.0.1. (Closed) Base URL: https://chromium.googlesource.com/chromium/deps/findbugs.git@master

Patch Set: Created 5 years, 5 months ago

Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.

Jump to:

View side-by-side diff with in-line comments

Download patch

Index: doc/manual/annotations.html

diff --git a/doc/manual/annotations.html b/doc/manual/annotations.html

index a9909f96e083ff17e244ed254329e1259fa10a8c..000d67a44135dc8ae1a718d703a20f0868600a08 100644

--- a/doc/manual/annotations.html

+++ b/doc/manual/annotations.html

@@ -1,23 +1,26 @@

- <title>Chapter 10. Annotations</title><meta name="generator" content="DocBook XSL Stylesheets V1.76.1"><link rel="home" href="index.html" title="FindBugs™ Manual"><link rel="up" href="index.html" title="FindBugs™ Manual"><link rel="prev" href="analysisprops.html" title="Chapter 9. Analysis Properties"><link rel="next" href="rejarForAnalysis.html" title="Chapter 11. Using rejarForAnalysis"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Chapter 10. Annotations</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="analysisprops.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="rejarForAnalysis.html">Next</a></td></tr></table><hr></div><div class="chapter" title="Chapter 10. Annotations"><div class="titlepage"><div><div><h2 class="title"><a name="annotations"></a>Chapter 10. Annotations</h2></div></div></div>

+ <title>Chapter 10. Annotations</title><meta name="generator" content="DocBook XSL Stylesheets V1.78.1"><link rel="home" href="index.html" title="FindBugs™ Manual"><link rel="up" href="index.html" title="FindBugs™ Manual"><link rel="prev" href="analysisprops.html" title="Chapter 9. Analysis Properties"><link rel="next" href="rejarForAnalysis.html" title="Chapter 11. Using rejarForAnalysis"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Chapter 10. Annotations</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="analysisprops.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="rejarForAnalysis.html">Next</a></td></tr></table><hr></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a name="annotations"></a>Chapter 10. Annotations</h1></div></div></div>

FindBugs supports several annotations to express the developer's intent

so that FindBugs can issue warnings more appropriately. You need to use

Java 5 to use annotations, and must place the annotations.jar and jsr305.jar

files in the classpath while compiling your program.

-<div class="variablelist"><dl><dt>edu.umd.cs.findbugs.annotations.CheckForNull</dt><dd>[Target] Field, Method, Parameter

-

+<div class="variablelist"><dl class="variablelist"><dt>edu.umd.cs.findbugs.annotations.CheckForNull</dt><dd>

+ [Target] Field, Method, Parameter

+

The annotated element might be null, and uses of the element should check for null.

When this annotation is applied to a method it applies to the method return value.

- </dd><dt>edu.umd.cs.findbugs.annotations.CheckReturnValue</dt><dd>[Target] Method, Constructor

- <div class="variablelist"><dl><dt>[Parameter]</dt><dd>

+ </dd><dt>edu.umd.cs.findbugs.annotations.CheckReturnValue</dt><dd>

+ [Target] Method, Constructor

+ <div class="variablelist"><dl class="variablelist"><dt>[Parameter]</dt><dd>

priority:The priority of the warning (HIGH, MEDIUM, LOW, IGNORE). Default value:MEDIUM.

explanation:A textual explaination of why the return value should be checked. Default value:"".

</dd></dl></div>

This annotation is used to denote a method whose return value should always be checked after invoking the method.

- </dd><dt>edu.umd.cs.findbugs.annotations.DefaultAnnotation</dt><dd>[Target] Type, Package

- <div class="variablelist"><dl><dt>[Parameter]</dt><dd>

+ </dd><dt>edu.umd.cs.findbugs.annotations.DefaultAnnotation</dt><dd>

+ [Target] Type, Package

+ <div class="variablelist"><dl class="variablelist"><dt>[Parameter]</dt><dd>

value:Annotation class objects. More than one class can be specified.

priority:Default priority(HIGH, MEDIUM, LOW, IGNORE). Default value:MEDIUM.

@@ -27,42 +30,48 @@ value of the supplied annotation classes. This would be used for behavior annota

such as @NonNull, @CheckForNull, or @CheckReturnValue. In particular, you can use

@DefaultAnnotation(NonNull.class) on a class or package, and then use @Nullable only

on those parameters, methods or fields that you want to allow to be null.

- </dd><dt>edu.umd.cs.findbugs.annotations.DefaultAnnotationForFields</dt><dd>[Target] Type, Package

- <div class="variablelist"><dl><dt>[Parameter]</dt><dd>

+ </dd><dt>edu.umd.cs.findbugs.annotations.DefaultAnnotationForFields</dt><dd>

+ [Target] Type, Package

+ <div class="variablelist"><dl class="variablelist"><dt>[Parameter]</dt><dd>

value:Annotation class objects. More than one class can be specified.

priority:Default priority(HIGH, MEDIUM, LOW, IGNORE). Default value:MEDIUM.

</dd></dl></div>

This is same as the DefaultAnnotation except it only applys to fields.

- </dd><dt>edu.umd.cs.findbugs.annotations.DefaultAnnotationForMethods</dt><dd>[Target] Type, Package

- <div class="variablelist"><dl><dt>[Parameter]</dt><dd>

+ </dd><dt>edu.umd.cs.findbugs.annotations.DefaultAnnotationForMethods</dt><dd>

+ [Target] Type, Package

+ <div class="variablelist"><dl class="variablelist"><dt>[Parameter]</dt><dd>

value:Annotation class objects. More than one class can be specified.

priority:Default priority(HIGH, MEDIUM, LOW, IGNORE). Default value:MEDIUM.

</dd></dl></div>

This is same as the DefaultAnnotation except it only applys to methods.

- </dd><dt>edu.umd.cs.findbugs.annotations.DefaultAnnotationForParameters</dt><dd>[Target] Type, Package

- <div class="variablelist"><dl><dt>[Parameter]</dt><dd>

+ </dd><dt>edu.umd.cs.findbugs.annotations.DefaultAnnotationForParameters</dt><dd>

+ [Target] Type, Package

+ <div class="variablelist"><dl class="variablelist"><dt>[Parameter]</dt><dd>

value:Annotation class objects. More than one class can be specified.

priority:Default priority(HIGH, MEDIUM, LOW, IGNORE). Default value:MEDIUM.

</dd></dl></div>

This is same as the DefaultAnnotation except it only applys to method parameters.

- </dd><dt>edu.umd.cs.findbugs.annotations.NonNull</dt><dd>[Target] Field, Method, Parameter

-

+ </dd><dt>edu.umd.cs.findbugs.annotations.NonNull</dt><dd>

+ [Target] Field, Method, Parameter

+

The annotated element must not be null.

Annotated fields must not be null after construction has completed. Annotated methods must have non-null return values.

- </dd><dt>edu.umd.cs.findbugs.annotations.Nullable</dt><dd>[Target] Field, Method, Parameter

-

+ </dd><dt>edu.umd.cs.findbugs.annotations.Nullable</dt><dd>

+ [Target] Field, Method, Parameter

+

The annotated element could be null under some circumstances. In general, this means

developers will have to read the documentation to determine when a null value is

acceptable and whether it is neccessary to check for a null value. FindBugs will

treat the annotated items as though they had no annotation.

-In pratice this annotation is useful only for overriding an overarching NonNull

+In practice this annotation is useful only for overriding an overarching NonNull

annotation.

- </dd><dt>edu.umd.cs.findbugs.annotations.OverrideMustInvoke</dt><dd>[Target] Method

- <div class="variablelist"><dl><dt>[Parameter]</dt><dd>

+ </dd><dt>edu.umd.cs.findbugs.annotations.OverrideMustInvoke</dt><dd>

+ [Target] Method

+ <div class="variablelist"><dl class="variablelist"><dt>[Parameter]</dt><dd>

value:Specify when the super invocation should be

performed (FIRST, ANYTIME, LAST). Default value:ANYTIME.

</dd></dl></div>

@@ -73,8 +82,9 @@ at any time, at the beginning of the overriding method, or at the end of the ove

(This anotation is not implmemented in FindBugs as of September 8, 2006).

</dd><dt>edu.umd.cs.findbugs.annotations.PossiblyNull</dt><dd>

This annotation is deprecated. Use CheckForNull instead.

- </dd><dt>edu.umd.cs.findbugs.annotations.SuppressWarnings</dt><dd>[Target] Type, Field, Method, Parameter, Constructor, Package

- <div class="variablelist"><dl><dt>[Parameter]</dt><dd>

+ </dd><dt>edu.umd.cs.findbugs.annotations.SuppressWarnings</dt><dd>

+ [Target] Type, Field, Method, Parameter, Constructor, Package

+ <div class="variablelist"><dl class="variablelist"><dt>[Parameter]</dt><dd>

value:The name of the warning. More than one name can be specified.

justification:Reason why the warning should be ignored. Default value:"".

@@ -86,15 +96,17 @@ must ignore any warning names they do not recognize. They are, however, free to

warning if an annotation contains an unrecognized warning name. Compiler vendors should

document the warning names they support in conjunction with this annotation type. They

are encouraged to cooperate to ensure that the same names work across multiple compilers.

- </dd><dt>edu.umd.cs.findbugs.annotations.UnknownNullness</dt><dd>[Target] Field, Method, Parameter

-

+ </dd><dt>edu.umd.cs.findbugs.annotations.UnknownNullness</dt><dd>

+ [Target] Field, Method, Parameter

+

Used to indicate that the nullness of the target is unknown, or my vary in unknown ways in subclasses.

-

+ </dd><dt>edu.umd.cs.findbugs.annotations.UnknownNullness</dt><dd>

+ [Target] Field, Method, Parameter

+

Used to indicate that the nullness of the target is unknown, or my vary in unknown ways in subclasses.

</dd></dl></div>

FindBugs also supports the following annotations:

-<div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">net.jcip.annotations.GuardedBy</li><li class="listitem">net.jcip.annotations.Immutable</li><li class="listitem">net.jcip.annotations.NotThreadSafe</li><li class="listitem">net.jcip.annotations.ThreadSafe</li></ul></div>

+<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">net.jcip.annotations.GuardedBy</li><li class="listitem">net.jcip.annotations.Immutable</li><li class="listitem">net.jcip.annotations.NotThreadSafe</li><li class="listitem">net.jcip.annotations.ThreadSafe</li></ul></div>

You can refer the JCIP annotation <a class="ulink" href="http://jcip.net/annotations/doc/index.html" target="_top">

API documentation</a> at <a class="ulink" href="http://jcip.net/" target="_top">Java Concurrency in Practice</a>.

« README.chromium ('K') | « doc/manual/analysisprops.html ('k') | doc/manual/anttask.html » ('j') | no next file with comments »