Skip to content

Document Java runtime namespace #570

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 2 commits into
base: main
Choose a base branch
from
Open

Document Java runtime namespace #570

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c5c09aa
Document Java runtime namespace
jonathanpeppers Aug 15, 2026
ca59680
Document Java runtime bootstrap APIs
jonathanpeppers Aug 15, 2026
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
73 changes: 49 additions & 24 deletions docs/xml/Java.Lang.Runtimes/ObjectMethods.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,23 @@
</Attribute>
</Attributes>
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<summary>Provides bootstrap methods for state-driven implementations of core object methods.</summary>
<remarks>
<para>
Java compilers can use these methods to implement <c>equals</c>, <c>hashCode</c>, and <c>toString</c> for record classes.
</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/java/lang/runtime/ObjectMethods" title="Reference documentation">Java documentation for <code>java.lang.runtime.ObjectMethods</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>
<Members>
<Member MemberName=".ctor">
Expand All @@ -45,10 +60,10 @@
<Parameter Name="transfer" Type="Android.Runtime.JniHandleOwnership" />
</Parameters>
<Docs>
<param name="javaReference">To be added.</param>
<param name="transfer">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<param name="javaReference">A <see cref="T:System.IntPtr" /> containing a Java Native Interface (JNI) object reference.</param>
<param name="transfer">A <see cref="T:Android.Runtime.JniHandleOwnership" /> indicating how to handle <paramref name="javaReference" />.</param>
<summary>A constructor used when creating managed representations of JNI objects; called by the runtime.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="Bootstrap">
Expand Down Expand Up @@ -97,15 +112,27 @@
</Parameter>
</Parameters>
<Docs>
<param name="lookup">To be added.</param>
<param name="methodName">To be added.</param>
<param name="type">To be added.</param>
<param name="recordClass">To be added.</param>
<param name="names">To be added.</param>
<param name="getters">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="lookup">A lookup context. This parameter is ignored.</param>
<param name="methodName">The name of the method to generate: <c>equals</c>, <c>hashCode</c>, or <c>toString</c>.</param>
<param name="type">The descriptor for the method or dynamic constant being linked.</param>
<param name="recordClass">The record class that declares the record components.</param>
<param name="names">A semicolon-separated list of component names, or an empty string when there are no components.</param>
<param name="getters">Method handles for the component accessor methods.</param>
<summary>Generates core object methods for a record class from its component names and accessors.</summary>
<returns>A call site for an <c>invokedynamic</c> call site, or a method handle for a dynamic constant-pool entry.</returns>
<remarks>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/java/lang/runtime/ObjectMethods#bootstrap(java.lang.invoke.MethodHandles.Lookup,java.lang.String,java.lang.invoke.TypeDescriptor,java.lang.Class,java.lang.String,java.lang.invoke.MethodHandle...)" title="Reference documentation">Java documentation for <code>java.lang.runtime.ObjectMethods.bootstrap</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>
</Member>
<Member MemberName="JniPeerMembers">
Expand All @@ -132,9 +159,9 @@
<ReturnType>Java.Interop.JniPeerMembers</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>Gets the JNI metadata used to invoke members of this Java peer.</summary>
<value>The JNI peer members for <c>ObjectMethods</c>.</value>
<remarks />
</Docs>
</Member>
<Member MemberName="ThresholdClass">
Expand All @@ -161,9 +188,8 @@
<ReturnType>System.IntPtr</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="ThresholdType">
Expand All @@ -190,9 +216,8 @@
<ReturnType>System.Type</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.</summary>
<remarks />
</Docs>
</Member>
</Members>
Expand Down
76 changes: 49 additions & 27 deletions docs/xml/Java.Lang.Runtimes/SwitchBootstraps.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,10 +62,10 @@
<Parameter Name="transfer" Type="Android.Runtime.JniHandleOwnership" />
</Parameters>
<Docs>
<param name="javaReference">To be added.</param>
<param name="transfer">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<param name="javaReference">A <see cref="T:System.IntPtr" /> containing a Java Native Interface (JNI) object reference.</param>
<param name="transfer">A <see cref="T:Android.Runtime.JniHandleOwnership" /> indicating how to handle <paramref name="javaReference" />.</param>
<summary>A constructor used when creating managed representations of JNI objects; called by the runtime.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="EnumSwitch">
Expand Down Expand Up @@ -109,13 +109,25 @@
</Parameter>
</Parameters>
<Docs>
<param name="lookup">To be added.</param>
<param name="invocationName">To be added.</param>
<param name="invocationType">To be added.</param>
<param name="labels">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="lookup">The lookup context with the caller's accessibility privileges.</param>
<param name="invocationName">Unused.</param>
<param name="invocationType">The call site invocation type with an enum parameter, an <c>int</c> parameter, and an <c>int</c> return type.</param>
<param name="labels">The case labels, represented by <see cref="T:System.String" /> constants or <see cref="T:Java.Lang.Class" /> instances.</param>
<summary>Links an <c>invokedynamic</c> call site that switches on an enum target.</summary>
<returns>A call site that returns the index of the first matching label.</returns>
<remarks>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/java/lang/runtime/SwitchBootstraps#enumSwitch(java.lang.invoke.MethodHandles.Lookup,java.lang.String,java.lang.invoke.MethodType,java.lang.Object...)" title="Reference documentation">Java documentation for <code>java.lang.runtime.SwitchBootstraps.enumSwitch</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>
</Member>
<Member MemberName="JniPeerMembers">
Expand All @@ -142,9 +154,9 @@
<ReturnType>Java.Interop.JniPeerMembers</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>Gets the JNI metadata used to invoke members of this Java peer.</summary>
<value>The JNI peer members for <c>SwitchBootstraps</c>.</value>
<remarks />
</Docs>
</Member>
<Member MemberName="ThresholdClass">
Expand All @@ -171,9 +183,8 @@
<ReturnType>System.IntPtr</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="ThresholdType">
Expand All @@ -200,9 +211,8 @@
<ReturnType>System.Type</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="TypeSwitch">
Expand Down Expand Up @@ -246,13 +256,25 @@
</Parameter>
</Parameters>
<Docs>
<param name="lookup">To be added.</param>
<param name="invocationName">To be added.</param>
<param name="invocationType">To be added.</param>
<param name="labels">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="lookup">The lookup context with the caller's accessibility privileges.</param>
<param name="invocationName">Unused.</param>
<param name="invocationType">The call site invocation type with a reference-type parameter, an <c>int</c> parameter, and an <c>int</c> return type.</param>
<param name="labels">The case labels, represented by <see cref="T:System.String" />, <see cref="T:System.Int32" />, <see cref="T:Java.Lang.Class" />, or enum-description values.</param>
<summary>Links an <c>invokedynamic</c> call site that switches on a reference-type target.</summary>
<returns>A call site that returns the index of the first matching label.</returns>
<remarks>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/java/lang/runtime/SwitchBootstraps#typeSwitch(java.lang.invoke.MethodHandles.Lookup,java.lang.String,java.lang.invoke.MethodType,java.lang.Object...)" title="Reference documentation">Java documentation for <code>java.lang.runtime.SwitchBootstraps.typeSwitch</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>
</Member>
</Members>
Expand Down
8 changes: 6 additions & 2 deletions docs/xml/ns-Java.Lang.Runtimes.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
<Namespace Name="Java.Lang.Runtimes">
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<summary>Provides bootstrap methods for Java language features.</summary>
<remarks>
<para>
This namespace contains bootstrap APIs for record-object methods and <c>switch</c> statement call sites.
</para>
</remarks>
</Docs>
</Namespace>