doc/ja/manual/annotations.html - Issue 594833004: Roll FindBugs from 2.0.3 to 3.0.0

Unified Diff: doc/ja/manual/annotations.html

Issue 594833004: Roll FindBugs from 2.0.3 to 3.0.0 (Closed) Base URL: https://chromium.googlesource.com/chromium/deps/findbugs.git@master

Patch Set: Created 6 years, 3 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/ja/manual/annotations.html

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

index 9a44cc67521af4f696c3756e16af5c1f1d16fb67..c1699aee25c45b9264c90e4031535e3a8d73419b 100644

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

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

@@ -1,55 +1,64 @@

- <title>第10章 アノテーション</title><meta name="generator" content="DocBook XSL Stylesheets V1.76.1"><link rel="home" href="index.html" title="FindBugs™ マニュアル"><link rel="up" href="index.html" title="FindBugs™ マニュアル"><link rel="prev" href="analysisprops.html" title="第9章 分析プロパティー"><link rel="next" href="rejarForAnalysis.html" title="第11章 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">第10章 アノテーション</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="analysisprops.html">戻る</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="rejarForAnalysis.html">次へ</a></td></tr></table><hr></div><div class="chapter" title="第10章 アノテーション"><div class="titlepage"><div><div><h2 class="title"><a name="annotations"></a>第10章 アノテーション</h2></div></div></div>FindBugs はいくつかのアノテーションをサポートしています。開発者の意図を明確にすることで、 FindBugs はより的確に警告を発行することができます。アノテーションを使用するためには Java 5 が必要であり、 annotations.jar および jsr305.jar ファイルをコンパイル時のクラスパスに含める必要があります。<div class="variablelist"><dl><dt>edu.umd.cs.findbugs.annotations.CheckForNull</dt><dd>[Target] Field, Method, Parameter

- アノテーションをつけた要素は、 null である可能性があります。したがって、当該要素を使用する際は null チェックをするべきです。このアノテーションをメソッドに適用すると、メソッドの戻り値に適用されます。</dd><dt>edu.umd.cs.findbugs.annotations.CheckReturnValue</dt><dd>[Target] Method, Constructor

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

+ <title>第10章 アノテーション</title><meta name="generator" content="DocBook XSL Stylesheets V1.76.1"><link rel="home" href="index.html" title="FindBugs™ マニュアル"><link rel="up" href="index.html" title="FindBugs™ マニュアル"><link rel="prev" href="analysisprops.html" title="第9章 分析プロパティー"><link rel="next" href="rejarForAnalysis.html" title="第11章 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">第10章 アノテーション</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="analysisprops.html">戻る</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="rejarForAnalysis.html">次へ</a></td></tr></table><hr></div><div class="chapter" title="第10章 アノテーション"><div class="titlepage"><div><div><h2 class="title"><a name="annotations"></a>第10章 アノテーション</h2></div></div></div>FindBugs はいくつかのアノテーションをサポートしています。開発者の意図を明確にすることで、 FindBugs はより的確に警告を発行することができます。アノテーションを使用するためには Java 5 が必要であり、 annotations.jar および jsr305.jar ファイルをコンパイル時のクラスパスに含める必要があります。<div class="variablelist"><dl><dt>edu.umd.cs.findbugs.annotations.CheckForNull</dt><dd>

+ [Target] Field, Method, Parameter

+ アノテーションをつけた要素は、 null である可能性があります。したがって、当該要素を使用する際は null チェックをするべきです。このアノテーションをメソッドに適用すると、メソッドの戻り値に適用されます。</dd><dt>edu.umd.cs.findbugs.annotations.CheckReturnValue</dt><dd>

+ [Target] Method, Constructor

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

priority: 警告の優先度を指定します (HIGH, MEDIUM, LOW, IGNORE) 。デフォルト値 :MEDIUM。

- explanation:戻り値をチェックしなけばならない理由をテキストで説明します。デフォルト値 :""。</dd></dl></div>このアノテーションを使用して、呼出し後に戻り値をチェックすべきメソッドを表すことができます。</dd><dt>edu.umd.cs.findbugs.annotations.DefaultAnnotation</dt><dd>[Target] Type, Package

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

+ explanation:戻り値をチェックしなけばならない理由をテキストで説明します。デフォルト値 :""。</dd></dl></div>このアノテーションを使用して、呼出し後に戻り値をチェックすべきメソッドを表すことができます。</dd><dt>edu.umd.cs.findbugs.annotations.DefaultAnnotation</dt><dd>

+ [Target] Type, Package

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

value:アノテーションクラスのclassオブジェクト。複数のクラスを指定することができます。

priority:省略時の優先度を指定します (HIGH, MEDIUM, LOW, IGNORE) 。デフォルト値 :MEDIUM。</dd></dl></div>

-Indicates that all members of the class or package should be annotated with the default

-value of the supplied annotation classes. This would be used for behavior annotations

-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>

+クラスまたはパッケージのすべてのメンバーが指定されたアノテーションクラスのデフォルト値でアノテートされることを指定することができます。

+この指定は @NonNull 、 @CheckForNull 、または @CheckReturnValueなどに使用する想定です。

+具体的には、 クラスまたはパッケージに @DefaultAnnotation(NonNull.class) を指定した上で、

+null を許容したいパラメーター、メソッドまたはフィールドにのみ @Nullable を指定するという使用方法があります。

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

+ [Target] Type, Package

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

value:アノテーションクラスのclassオブジェクト。複数のクラスを指定することができます。

priority:省略時の優先度を指定します (HIGH, MEDIUM, LOW, IGNORE) 。デフォルト値 :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>

+フィールドのみに適用されること以外は DefaultAnnotation と同様です。

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

+ [Target] Type, Package

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

value:アノテーションクラスのclassオブジェクト。複数のクラスを指定することができます。

priority:省略時の優先度を指定します (HIGH, MEDIUM, LOW, IGNORE) 。デフォルト値 :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>

+メソッドのみに適用されること以外は DefaultAnnotation と同様です。

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

+ [Target] Type, Package

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

value:アノテーションクラスのclassオブジェクト。複数のクラスを指定することができます。

priority:省略時の優先度を指定します (HIGH, MEDIUM, LOW, IGNORE) 。デフォルト値 :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

- アノテーションをつけた要素は、 null であってはいけません。アノテーションをつけたフィールドは、構築完了後 null であってはいけません。アノテーションをつけたメソッドは、 null ではない値を戻り値としなければなりません。</dd><dt>edu.umd.cs.findbugs.annotations.Nullable</dt><dd>[Target] Field, Method, Parameter

- アノテーションをつけた要素は、 null であってはいけません。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

-annotation.

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

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

- value:Specify when the super invocation should be

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

+パラメーターのみに適用されること以外は DefaultAnnotation と同様です。

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

+ [Target] Field, Method, Parameter

+ アノテーションをつけた要素は、 null であってはいけません。アノテーションをつけたフィールドは、構築完了後 null であってはいけません。アノテーションをつけたメソッドは、 null ではない値を戻り値としなければなりません。</dd><dt>edu.umd.cs.findbugs.annotations.Nullable</dt><dd>

+ [Target] Field, Method, Parameter

+

+アノテーションをつけた要素は、 条件により null である可能性があります。

+一般に、開発者はドキュメントを読んで null 値を許容するかどうかまたは null 値をチェックするかどうかを決定する必要があります。

+FindBugs はこのアノテーションをつけた要素を、アノテーションがついていないものと同様に扱います。

+

+実際には、このアノテーションは NonNull をつけた要素をオーバーライドする場合に有用です。

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

+ [Target] Method

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

+ value:super の呼び出し箇所を指定します (FIRST, ANYTIME, LAST)。 デフォルト値 :ANYTIME。

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

-Used to annotate a method that, if overridden, must (or should) be invoke super

-in the overriding method. Examples of such methods include finalize() and clone().

-The argument to the method indicates when the super invocation should occur:

-at any time, at the beginning of the overriding method, or at the end of the overriding method.

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

+オーバーライドされた場合にオーバーライドメソッド内で super を呼び出すべきメソッドにアノテートします。

+例えば、 finalize() や clone() がそのようなメソッドに該当します。

+引数は、 super の呼び出し箇所を指定します。すなわち、随時、メソッドの最初またはメソッドの最後です。

</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>

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

+非推奨です。 CheckForNull を使用してください。

+ </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>

+ value:警告の名称。複数の名称を指定することができます。

- justification:Reason why the warning should be ignored. デフォルト値 :""。</dd></dl></div>

+ justification:警告を無視する理由。 デフォルト値 :""。</dd></dl></div>

The set of warnings that are to be suppressed by the compiler in the annotated element.

Duplicate names are permitted. The second and successive occurrences of a name are ignored.

The presence of unrecognized warning names is not an error: Compilers

@@ -57,11 +66,13 @@ 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 次に示すアノテーションもサポートしています。 :<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>

+ </dd></dl></div>また、 FindBugs 次に示すアノテーションもサポートしています。 :<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>

<a class="ulink" href="http://jcip.net/" target="_top">Java Concurrency in Practice</a> の <a class="ulink" href="http://jcip.net/annotations/doc/index.html" target="_top"> API ドキュメント</a> を参照してください。</div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="analysisprops.html">戻る</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="rejarForAnalysis.html">次へ</a></td></tr><tr><td width="40%" align="left" valign="top">第9章 分析プロパティー </td><td width="20%" align="center"><a accesskey="h" href="index.html">ホーム</a></td><td width="40%" align="right" valign="top"> 第11章 rejarForAnalysis の使用方法</td></tr></table></div></body></html>

« no previous file with comments | « doc/ja/manual/acknowledgments.html ('k') | doc/ja/manual/anttask.html » ('j') | no next file with comments »