Skip to content

Document XML datatype APIs #511

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
+20 −20
Open

Document XML datatype APIs #511

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
36e5709
Document XML datatype APIs
jonathanpeppers Aug 14, 2026
ee326a0
Link undefined calendar fields
jonathanpeppers Aug 14, 2026
78551df
Correct XML datatype contracts
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
8 changes: 4 additions & 4 deletions docs/xml/Javax.Xml.Datatype/DatatypeFactory.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,7 @@
</ReturnValue>
<Docs>
<summary>Default implementation class name as defined in JSR 206: Java(TM) API for XML Processing (JAXP) 1.</summary>
<value>To be added.</value>
<value>The default implementation class name.</value>
<remarks>
<para>Default implementation class name as defined in JSR 206: Java(TM) API for XML Processing (JAXP) 1.3.</para>
<para>Default value is <c>org.apache.xerces.jaxp.datatype.DatatypeFactoryImpl</c>.</para>
Expand Down Expand Up @@ -1063,10 +1063,10 @@
<Parameter Name="classLoader" Type="Java.Lang.ClassLoader" />
</Parameters>
<Docs>
<param name="factoryClassName">To be added.</param>
<param name="classLoader">To be added.</param>
<param name="factoryClassName">The fully qualified name of the factory class that provides the <c>javax.xml.datatype.DatatypeFactory</c> implementation.</param>
<param name="classLoader">The <c>ClassLoader</c> used to load the factory class. If <see langword="null" />, the current thread's context class loader is used.</param>
<summary>Returns an instance of the named implementation of <c>DatatypeFactory</c>.</summary>
<returns>New instance of a &lt;code&gt;DocumentBuilderFactory&lt;/code&gt;</returns>
<returns>A new instance of <c>DatatypeFactory</c>.</returns>
<remarks>
<para>Returns an instance of the named implementation of <c>DatatypeFactory</c>.</para>
<para>Added in 1.6.</para>
Expand Down
4 changes: 2 additions & 2 deletions docs/xml/Javax.Xml.Datatype/Duration.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -489,7 +489,7 @@
<Parameters />
<Docs>
<summary>Returns a hash code consistent with the definition of the equals method.</summary>
<returns>To be added.</returns>
<returns>A hash code consistent with the definition of <c>Equals</c>.</returns>
<remarks>
<para>Returns a hash code consistent with the definition of the equals method.</para>
<para>
Expand Down Expand Up @@ -1241,7 +1241,7 @@
</ReturnValue>
<Docs>
<summary>Returns the sign of this duration in -1,0, or 1.</summary>
<value>To be added.</value>
<value>-1 if this duration is negative, 0 if it is zero, or 1 if it is positive.</value>
<remarks>
<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>
Expand Down
28 changes: 14 additions & 14 deletions docs/xml/Javax.Xml.Datatype/XMLGregorianCalendar.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -421,7 +421,7 @@
<Docs>
<summary tool="true">
</summary>
<value>To be added.</value>
<value>The day of month, from 1 to 31, or <see cref="F:Javax.Xml.Datatype.DatatypeConstants.FieldUndefined" /> if undefined.</value>
<remarks>
<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>
Expand Down Expand Up @@ -455,7 +455,7 @@
<Docs>
<summary tool="true">
</summary>
<value>To be added.</value>
<value>The high-order component of the year, expressed as a multiple of 10^9, or <see langword="null" /> if undefined.</value>
<remarks>
<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>
Expand Down Expand Up @@ -486,7 +486,7 @@
<Docs>
<summary>
</summary>
<value>To be added.</value>
<value>The sum of the eon and year when both are defined; the year when only it is defined; otherwise, <see langword="null" />.</value>
<remarks>
<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>
Expand Down Expand Up @@ -521,7 +521,7 @@
<Docs>
<summary>
</summary>
<value>To be added.</value>
<value>The fractional seconds, or <see langword="null" /> if undefined.</value>
<remarks>
<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>
Expand Down Expand Up @@ -608,7 +608,7 @@
</ReturnValue>
<Docs>
<summary>Return hours or <see cref="F:Javax.Xml.Datatype.DatatypeConstants.FieldUndefined" />.</summary>
<value>To be added.</value>
<value>The hour of day, from 0 to 24, or <see cref="F:Javax.Xml.Datatype.DatatypeConstants.FieldUndefined" /> if undefined. When the value is 24, the minute and second values must be zero.</value>
<remarks>
<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>
Expand Down Expand Up @@ -640,7 +640,7 @@
</ReturnValue>
<Docs>
<summary>Validate instance by <c>getXMLSchemaType()</c> constraints.</summary>
<value>To be added.</value>
<value><see langword="true" /> if the data values are valid; otherwise, <see langword="false" />.</value>
<remarks>
<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>
Expand Down Expand Up @@ -763,7 +763,7 @@
<Docs>
<summary tool="true">
Returns <see cref="F:Javax.Xml.Datatype.DatatypeConstants.FieldUndefined" /> if this field is not defined.</summary>
<value>To be added.</value>
<value>The minute of hour, from 0 to 59, or <see cref="F:Javax.Xml.Datatype.DatatypeConstants.FieldUndefined" /> if undefined.</value>
<remarks>
<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>
Expand Down Expand Up @@ -800,7 +800,7 @@
<Docs>
<summary>
</summary>
<value>To be added.</value>
<value>The month, from 1 to 12, or <see cref="F:Javax.Xml.Datatype.DatatypeConstants.FieldUndefined" /> if undefined.</value>
<remarks>
<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>
Expand Down Expand Up @@ -966,7 +966,7 @@
<Docs>
<summary>
</summary>
<value>To be added.</value>
<value>The second of minute, from 0 to 59, or <see cref="F:Javax.Xml.Datatype.DatatypeConstants.FieldUndefined" /> if undefined.</value>
<remarks>
<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>
Expand Down Expand Up @@ -1324,7 +1324,7 @@
<Docs>
<summary>Return timezone offset in minutes or
<see cref="F:Javax.Xml.Datatype.DatatypeConstants.FieldUndefined" /> if this optional field is not defined.</summary>
<value>To be added.</value>
<value>The timezone offset in minutes, or <see cref="F:Javax.Xml.Datatype.DatatypeConstants.FieldUndefined" /> if undefined.</value>
<remarks>
<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>
Expand Down Expand Up @@ -1358,7 +1358,7 @@
<Parameters />
<Docs>
<summary>Convert this <c>XMLGregorianCalendar</c> to a <c>GregorianCalendar</c>.</summary>
<returns>To be added.</returns>
<returns>A <see cref="T:Java.Util.GregorianCalendar" /> instance.</returns>
<remarks>
<para>Convert this <c>XMLGregorianCalendar</c> to a <c>GregorianCalendar</c>.</para>
<para>When <c>this</c> instance has an undefined field, this
Expand Down Expand Up @@ -1600,8 +1600,8 @@
<ReturnType>Javax.Xml.Namespace.QName</ReturnType>
</ReturnValue>
<Docs>
<summary tool="true">To be added.</summary>
<value>To be added.</value>
<summary tool="true">Returns the XML Schema date/time datatype name for this calendar.</summary>
<value>The <see cref="T:Javax.Xml.Namespace.QName" /> for this XML Schema date/time datatype.</value>
<remarks>
<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>
Expand Down Expand Up @@ -1637,7 +1637,7 @@
<Docs>
<summary>
</summary>
<value>To be added.</value>
<value>The low-order component of the year, or <see cref="F:Javax.Xml.Datatype.DatatypeConstants.FieldUndefined" /> if undefined.</value>
<remarks>
<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>
Expand Down