Skip to content

Document TemporalField unit properties #498

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 3 commits into
base: main
Choose a base branch
from
+77 −12
Open

Document TemporalField unit properties #498

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c7c1c63
Document TemporalField unit properties
jonathanpeppers Aug 14, 2026
df042af
Clarify TemporalField range unit
jonathanpeppers Aug 14, 2026
affdf9c
Use managed ChronoField references
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
89 changes: 77 additions & 12 deletions docs/xml/Java.Time.Temporal/ITemporalField.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,9 +151,24 @@
<ReturnType>Java.Time.Temporal.ITemporalUnit</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>Gets the unit that the field is measured in.</summary>
<value>the unit defining the base unit of the field, not null</value>
<remarks>
<para>Gets the unit that the field is measured in.</para>
<para>The unit of the field is the period that varies within the range.
For example, in the field <c>MonthOfYear</c>, the unit is <c>Months</c>.
See also <c>getRangeUnit()</c>.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/java/time/temporal/TemporalField#getBaseUnit()" title="Reference documentation">Java documentation for <code>java.time.temporal.TemporalField.getBaseUnit()</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="GetDisplayName">
Expand Down Expand Up @@ -287,9 +302,25 @@
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>Checks if this field represents a component of a date.</summary>
<value>true if this field is a component of a date</value>
<remarks>
<para>Checks if this field represents a component of a date.</para>
<para>A field is date-based if it can be derived from
<see cref="P:Java.Time.Temporal.ChronoField.EpochDay" />.
Both <c>isDateBased()</c> and <c>isTimeBased()</c> may return false,
such as for a field representing minute-of-week.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/java/time/temporal/TemporalField#isDateBased()" title="Reference documentation">Java documentation for <code>java.time.temporal.TemporalField.isDateBased()</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="IsSupportedBy">
Expand Down Expand Up @@ -374,9 +405,25 @@
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>Checks if this field represents a component of a time.</summary>
<value>true if this field is a component of a time</value>
<remarks>
<para>Checks if this field represents a component of a time.</para>
<para>A field is time-based if it can be derived from
<see cref="P:Java.Time.Temporal.ChronoField.NanoOfDay" />.
Both <c>isDateBased()</c> and <c>isTimeBased()</c> may return false,
such as for a field representing minute-of-week.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/java/time/temporal/TemporalField#isTimeBased()" title="Reference documentation">Java documentation for <code>java.time.temporal.TemporalField.isTimeBased()</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="Range">
Expand Down Expand Up @@ -516,9 +563,27 @@
<ReturnType>Java.Time.Temporal.ITemporalUnit</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>Gets the unit that defines the range of the field.</summary>
<value>the unit defining the range of the field, not null</value>
<remarks>
<para>Gets the unit that defines the range of the field.</para>
<para>The range of the field is the period that the field varies within.
For example, in the field <c>MonthOfYear</c>, the range is <c>Years</c>.
See also <c>getBaseUnit()</c>.</para>
<para>The range is never null. For example, the <c>Year</c> field is shorthand for
<c>YearOfForever</c>. It therefore has a unit of <c>Years</c> and a range of
<c>Forever</c>.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/java/time/temporal/TemporalField#getRangeUnit()" title="Reference documentation">Java documentation for <code>java.time.temporal.TemporalField.getRangeUnit()</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="Resolve">
Expand Down