Skip to content

Document ZoneRules query APIs #485

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
Open

Document ZoneRules query APIs #485

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c4c3417
Document ZoneRules query APIs
jonathanpeppers Aug 14, 2026
1cc6496
Clarify daylight savings return value
jonathanpeppers Aug 14, 2026
e4b3a1c
Document ZoneRules factory constraints
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
97 changes: 44 additions & 53 deletions docs/xml/Java.Time.Zone/ZoneRules.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,10 +95,9 @@
<Parameter Name="instant" Type="Java.Time.Instant" />
</Parameters>
<Docs>
<param name="instant">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="instant">The instant to find the daylight savings for.</param>
<summary>Gets the amount of daylight savings in use for the specified instant in this zone.</summary>
<returns>The difference between the standard offset and the actual offset in use at the specified instant.</returns>
</Docs>
</Member>
<Member MemberName="GetOffset">
Expand Down Expand Up @@ -128,10 +127,9 @@
<Parameter Name="instant" Type="Java.Time.Instant" />
</Parameters>
<Docs>
<param name="instant">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="instant">The instant to find the offset for.</param>
<summary>Gets the offset applicable at the specified instant in these rules.</summary>
<returns>The offset applicable at the specified instant.</returns>
</Docs>
</Member>
<Member MemberName="GetOffset">
Expand Down Expand Up @@ -161,10 +159,9 @@
<Parameter Name="localDateTime" Type="Java.Time.LocalDateTime" />
</Parameters>
<Docs>
<param name="localDateTime">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="localDateTime">The local date-time to query.</param>
<summary>Gets a suitable offset for the specified local date-time in these rules.</summary>
<returns>The best available offset for the local date-time.</returns>
</Docs>
</Member>
<Member MemberName="GetStandardOffset">
Expand Down Expand Up @@ -194,10 +191,9 @@
<Parameter Name="instant" Type="Java.Time.Instant" />
</Parameters>
<Docs>
<param name="instant">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="instant">The instant to find the offset information for.</param>
<summary>Gets the standard offset for the specified instant in this zone.</summary>
<returns>The standard offset for the specified instant.</returns>
</Docs>
</Member>
<Member MemberName="GetTransition">
Expand Down Expand Up @@ -227,10 +223,9 @@
<Parameter Name="localDateTime" Type="Java.Time.LocalDateTime" />
</Parameters>
<Docs>
<param name="localDateTime">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="localDateTime">The local date-time to query for an offset transition.</param>
<summary>Gets the offset transition applicable at the specified local date-time in these rules.</summary>
<returns>The transition for a gap or overlap; otherwise, <see langword="null" />.</returns>
</Docs>
</Member>
<Member MemberName="GetValidOffsets">
Expand Down Expand Up @@ -266,10 +261,9 @@
<Parameter Name="localDateTime" Type="Java.Time.LocalDateTime" />
</Parameters>
<Docs>
<param name="localDateTime">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="localDateTime">The local date-time to query for valid offsets.</param>
<summary>Gets the offsets applicable at the specified local date-time in these rules.</summary>
<returns>The list of valid offsets.</returns>
</Docs>
</Member>
<Member MemberName="IsDaylightSavings">
Expand Down Expand Up @@ -299,10 +293,9 @@
<Parameter Name="instant" Type="Java.Time.Instant" />
</Parameters>
<Docs>
<param name="instant">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="instant">The instant to check for daylight savings.</param>
<summary>Checks whether the specified instant is in daylight savings.</summary>
<returns><see langword="true" /> if the specified instant is in daylight savings; otherwise, <see langword="false" />.</returns>
</Docs>
</Member>
<Member MemberName="IsFixedOffset">
Expand Down Expand Up @@ -374,11 +367,10 @@
<Parameter Name="offset" Type="Java.Time.ZoneOffset" />
</Parameters>
<Docs>
<param name="localDateTime">To be added.</param>
<param name="offset">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="localDateTime">The local date-time to check.</param>
<param name="offset">The offset to check.</param>
<summary>Checks whether the offset date-time is valid for these rules.</summary>
<returns><see langword="true" /> if the offset date-time is valid for these rules; otherwise, <see langword="false" />.</returns>
</Docs>
</Member>
<Member MemberName="JniPeerMembers">
Expand Down Expand Up @@ -446,10 +438,9 @@
<Parameter Name="instant" Type="Java.Time.Instant" />
</Parameters>
<Docs>
<param name="instant">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="instant">The instant after which to get the next transition.</param>
<summary>Gets the next transition after the specified instant.</summary>
<returns>The next transition after the specified instant, or <see langword="null" /> if it is after the last transition.</returns>
</Docs>
</Member>
<Member MemberName="Of">
Expand Down Expand Up @@ -479,10 +470,10 @@
<Parameter Name="offset" Type="Java.Time.ZoneOffset" />
</Parameters>
<Docs>
<param name="offset">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="offset">The non-null offset to use for the rules.</param>
<summary>Obtains an instance of <see cref="T:Java.Time.Zone.ZoneRules" /> with a fixed offset.</summary>
<returns>The zone rules with the specified fixed offset.</returns>
<exception cref="T:Java.Lang.NullPointerException">Thrown if <paramref name="offset" /> is <see langword="null" />.</exception>
</Docs>
</Member>
<Member MemberName="Of">
Expand Down Expand Up @@ -537,14 +528,15 @@
</Parameter>
</Parameters>
<Docs>
<param name="baseStandardOffset">To be added.</param>
<param name="baseWallOffset">To be added.</param>
<param name="standardOffsetTransitionList">To be added.</param>
<param name="transitionList">To be added.</param>
<param name="lastRules">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="baseStandardOffset">The non-null standard offset to use before legal rules were set.</param>
<param name="baseWallOffset">The non-null wall offset to use before legal rules were set.</param>
<param name="standardOffsetTransitionList">The non-null list of changes to the standard offset.</param>
<param name="transitionList">The non-null list of transitions.</param>
<param name="lastRules">The non-null recurring last rules, with at most 16 entries.</param>
<summary>Obtains an instance of <see cref="T:Java.Time.Zone.ZoneRules" />.</summary>
<returns>The zone rules.</returns>
<exception cref="T:Java.Lang.NullPointerException">Thrown if any argument is <see langword="null" />.</exception>
<exception cref="T:Java.Lang.IllegalArgumentException">Thrown if <paramref name="lastRules" /> contains more than 16 rules.</exception>
</Docs>
</Member>
<Member MemberName="PreviousTransition">
Expand Down Expand Up @@ -574,10 +566,9 @@
<Parameter Name="instant" Type="Java.Time.Instant" />
</Parameters>
<Docs>
<param name="instant">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="instant">The instant before which to get the previous transition.</param>
<summary>Gets the previous transition before the specified instant.</summary>
<returns>The previous transition before the specified instant, or <see langword="null" /> if it is before the first transition.</returns>
</Docs>
</Member>
<Member MemberName="ThresholdClass">
Expand Down