You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@ws.apache.org by dk...@apache.org on 2019/10/31 14:48:44 UTC
[ws-axiom] 07/25: Complete the Javadoc of Temporal.
This is an automated email from the ASF dual-hosted git repository.
dkulp pushed a commit to branch datatypes
in repository https://gitbox.apache.org/repos/asf/ws-axiom.git
commit c4de7e5dbdc9041f4ce347307745282ff9645bb6
Author: Andreas Veithen <ve...@apache.org>
AuthorDate: Tue Nov 17 22:56:15 2015 +0000
Complete the Javadoc of Temporal.
---
.../src/main/java/org/apache/axiom/datatype/xsd/Temporal.java | 10 ++++++++--
1 file changed, 8 insertions(+), 2 deletions(-)
diff --git a/datatypes/src/main/java/org/apache/axiom/datatype/xsd/Temporal.java b/datatypes/src/main/java/org/apache/axiom/datatype/xsd/Temporal.java
index 0d808f6..c971da9 100644
--- a/datatypes/src/main/java/org/apache/axiom/datatype/xsd/Temporal.java
+++ b/datatypes/src/main/java/org/apache/axiom/datatype/xsd/Temporal.java
@@ -21,13 +21,19 @@ package org.apache.axiom.datatype.xsd;
import java.util.GregorianCalendar;
import java.util.TimeZone;
+/**
+ * A temporal value. This is the base interface for {@link XSDate}, {@link XSTime} and
+ * {@link XSDateTime}.
+ */
public interface Temporal {
/**
+ * Convert this value to a calendar. For {@link XSDate} and {@link XSTime}, only the
+ * corresponding fields are filled in and all other fields are left unspecified.
*
* @param defaultTimeZone
* the time zone to use if this temporal object has no time zone; may be
* <code>null</code>
- * @return
+ * @return the calendar
* @throws NoTimeZoneException
* if this temporal object doesn't have a time zone and no default time zone was
* specified
@@ -35,7 +41,7 @@ public interface Temporal {
GregorianCalendar getCalendar(TimeZone defaultTimeZone);
/**
- * Determine if this temporal object has a time zone.
+ * Determine if this temporal value has a time zone.
*
* @return <code>true</code> if the object has a time zone, <code>false</code> otherwise
*/