Skip to content

Document Java reflection annotation APIs #577

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jonathanpeppers wants to merge 1 commit into
base: main
Choose a base branch
from
+49 −43
Open

Document Java reflection annotation APIs #577

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 20 additions & 20 deletions docs/xml/Java.Lang.Reflect/AccessibleObject.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -224,9 +224,9 @@
<Parameter Name="annotationClass" Type="Java.Lang.Class" />
</Parameters>
<Docs>
<param name="annotationClass">To be added.</param>
<summary>Added in 1.</summary>
<returns>To be added.</returns>
<param name="annotationClass">the Class object corresponding to the annotation type</param>
<summary>Returns this object's annotation for the specified type if the annotation is <em>present</em>; otherwise, returns null.</summary>
<returns>this object's annotation for the specified annotation type if present; otherwise, null</returns>
<remarks>
<para>Added in 1.5.</para>
<para>
Expand Down Expand Up @@ -266,8 +266,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>Added in 1.</summary>
<returns>To be added.</returns>
<summary>Returns annotations that are <em>present</em> on this object.</summary>
<returns>annotations present on this object</returns>
<remarks>
<para>Added in 1.5.</para>
<para>
Expand Down Expand Up @@ -324,9 +324,9 @@
<Parameter Name="annotationClass" Type="Java.Lang.Class" />
</Parameters>
<Docs>
<param name="annotationClass">To be added.</param>
<summary>Added in 1.</summary>
<returns>To be added.</returns>
<param name="annotationClass">the Class object corresponding to the annotation type</param>
<summary>Returns annotations of the specified type that are <em>associated</em> with this object.</summary>
<returns>all annotations of the specified type associated with this object; otherwise, an array of length zero</returns>
<remarks>
<para>Added in 1.8.</para>
<para>
Expand Down Expand Up @@ -382,9 +382,9 @@
<Parameter Name="annotationClass" Type="Java.Lang.Class" />
</Parameters>
<Docs>
<param name="annotationClass">To be added.</param>
<summary>Added in 1.</summary>
<returns>To be added.</returns>
<param name="annotationClass">the Class object corresponding to the annotation type</param>
<summary>Returns this object's annotation for the specified type if the annotation is <em>directly present</em>; otherwise, returns null.</summary>
<returns>this object's annotation for the specified annotation type if directly present; otherwise, null</returns>
<remarks>
<para>Added in 1.8.</para>
<para>
Expand Down Expand Up @@ -424,8 +424,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>Added in 1.</summary>
<returns>To be added.</returns>
<summary>Returns annotations that are <em>directly present</em> on this object.</summary>
<returns>annotations directly present on this object</returns>
<remarks>
<para>Added in 1.5.</para>
<para>
Expand Down Expand Up @@ -482,9 +482,9 @@
<Parameter Name="annotationClass" Type="Java.Lang.Class" />
</Parameters>
<Docs>
<param name="annotationClass">To be added.</param>
<summary>Added in 1.</summary>
<returns>To be added.</returns>
<param name="annotationClass">the Class object corresponding to the annotation type</param>
<summary>Returns annotations of the specified type that are <em>directly present</em> or <em>indirectly present</em> on this object.</summary>
<returns>all annotations of the specified type directly or indirectly present on this object; otherwise, an array of length zero</returns>
<remarks>
<para>Added in 1.8.</para>
<para>
Expand Down Expand Up @@ -526,11 +526,11 @@
<Parameter Name="annotationClass" Type="Java.Lang.Class" />
</Parameters>
<Docs>
<param name="annotationClass">To be added.</param>
<summary>To be added</summary>
<returns>To be added.</returns>
<param name="annotationClass">the Class object corresponding to the annotation type</param>
<summary>Returns true if an annotation of the specified type is <em>present</em> on this object; otherwise, returns false.</summary>
<returns>true if an annotation of the specified annotation type is present on this object; otherwise, false</returns>
<remarks>
<para>To be added</para>
<para>Returns true if an annotation of the specified type is <em>present</em> on this object; otherwise, returns false. This is equivalent to <c>GetAnnotation(annotationClass) != null</c>.</para>
<para>Added in 1.5.</para>
<para>
<format type="text/html">
Expand Down
52 changes: 29 additions & 23 deletions docs/xml/Java.Lang.Reflect/Parameter.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,11 +141,11 @@
<Parameter Name="annotationClass" Type="Java.Lang.Class" />
</Parameters>
<Docs>
<param name="annotationClass">To be added.</param>
<summary>To be added</summary>
<returns>To be added.</returns>
<param name="annotationClass">the Class object corresponding to the annotation type</param>
<summary>Returns this parameter's annotation for the specified type if the annotation is <em>present</em>; otherwise, returns null.</summary>
<returns>this parameter's annotation for the specified annotation type if present; otherwise, null</returns>
<remarks>
<para>To be added</para>
<para>Returns this parameter's annotation for the specified type if the annotation is <em>present</em>; otherwise, returns null.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/java/lang/reflect/Parameter#getAnnotation(java.lang.Class%3CT%3E)" title="Reference documentation">Java documentation for <code>java.lang.reflect.Parameter.getAnnotation(java.lang.Class&lt;T&gt;)</code>.</a>
Expand Down Expand Up @@ -187,10 +187,10 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>To be added.</returns>
<summary>Returns annotations that are <em>present</em> on this parameter.</summary>
<returns>annotations present on this parameter</returns>
<remarks>
<para>To be added</para>
<para>Returns annotations that are <em>present</em> on this parameter. If no annotations are present, the returned array has length zero. Modifying the returned array does not affect arrays returned to other callers.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/java/lang/reflect/Parameter#getAnnotations()" title="Reference documentation">Java documentation for <code>java.lang.reflect.Parameter.getAnnotations()</code>.</a>
Expand Down Expand Up @@ -244,11 +244,11 @@
<Parameter Name="annotationClass" Type="Java.Lang.Class" />
</Parameters>
<Docs>
<param name="annotationClass">To be added.</param>
<summary>To be added</summary>
<returns>To be added.</returns>
<param name="annotationClass">the Class object corresponding to the annotation type</param>
<summary>Returns annotations of the specified type that are <em>associated</em> with this parameter.</summary>
<returns>all annotations of the specified type associated with this parameter; otherwise, an array of length zero</returns>
<remarks>
<para>To be added</para>
<para>Returns annotations that are <em>associated</em> with this parameter. For a repeatable annotation type, this method looks through a container annotation. If no annotations are associated, the returned array has length zero.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/java/lang/reflect/Parameter#getAnnotationsByType(java.lang.Class%3CT%3E)" title="Reference documentation">Java documentation for <code>java.lang.reflect.Parameter.getAnnotationsByType(java.lang.Class&lt;T&gt;)</code>.</a>
Expand Down Expand Up @@ -302,9 +302,9 @@
<Parameter Name="annotationClass" Type="Java.Lang.Class" />
</Parameters>
<Docs>
<param name="annotationClass">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="annotationClass">the Class object corresponding to the annotation type</param>
<summary>Returns this parameter's annotation for the specified type if the annotation is <em>directly present</em>; otherwise, returns null.</summary>
<returns>this parameter's annotation for the specified annotation type if directly present; otherwise, null</returns>
<remarks>
<para>
<format type="text/html">
Expand Down Expand Up @@ -347,10 +347,10 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>To be added.</returns>
<summary>Returns annotations that are <em>directly present</em> on this parameter.</summary>
<returns>annotations directly present on this parameter</returns>
<remarks>
<para>To be added</para>
<para>Returns annotations that are <em>directly present</em> on this parameter and ignores inherited annotations. If no annotations are directly present, the returned array has length zero. Modifying the returned array does not affect arrays returned to other callers.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/java/lang/reflect/Parameter#getDeclaredAnnotations()" title="Reference documentation">Java documentation for <code>java.lang.reflect.Parameter.getDeclaredAnnotations()</code>.</a>
Expand Down Expand Up @@ -404,9 +404,9 @@
<Parameter Name="annotationClass" Type="Java.Lang.Class" />
</Parameters>
<Docs>
<param name="annotationClass">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="annotationClass">the Class object corresponding to the annotation type</param>
<summary>Returns annotations of the specified type that are <em>directly present</em> or <em>indirectly present</em> on this parameter.</summary>
<returns>all annotations of the specified type directly or indirectly present on this parameter; otherwise, an array of length zero</returns>
<remarks>
<para>
<format type="text/html">
Expand Down Expand Up @@ -441,10 +441,16 @@
<Parameter Name="annotationClass" Type="Java.Lang.Class" />
</Parameters>
<Docs>
<param name="annotationClass">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="annotationClass">the Class object corresponding to the annotation type</param>
<summary>Returns true if an annotation of the specified type is <em>present</em> on this parameter; otherwise, returns false.</summary>
<returns>true if an annotation of the specified annotation type is present on this parameter; otherwise, false</returns>
<remarks>
<para>Returns true if an annotation of the specified type is <em>present</em> on this parameter; otherwise, returns false. This is equivalent to <c>GetAnnotation(annotationClass) != null</c>.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/java/lang/reflect/Parameter#isAnnotationPresent(java.lang.Class%3C?%20extends%20java.lang.annotation.Annotation%3E)" title="Reference documentation">Java documentation for <code>java.lang.reflect.Parameter.isAnnotationPresent(java.lang.Class&lt;? extends java.lang.annotation.Annotation&gt;)</code>.</a>
</format>
</para>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
</Docs>
Expand Down