src/share/classes/java/time/chrono/ThaiBuddhistDate.java

Print this page

        

@@ -52,44 +52,52 @@
  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
-package java.time.calendar;
+package java.time.chrono;
 
-import static java.time.calendar.ThaiBuddhistChrono.YEARS_DIFFERENCE;
+import static java.time.chrono.ThaiBuddhistChronology.YEARS_DIFFERENCE;
 import static java.time.temporal.ChronoField.DAY_OF_MONTH;
 import static java.time.temporal.ChronoField.MONTH_OF_YEAR;
 import static java.time.temporal.ChronoField.YEAR;
 
 import java.io.DataInput;
 import java.io.DataOutput;
 import java.io.IOException;
 import java.io.Serializable;
+import java.time.Clock;
 import java.time.DateTimeException;
 import java.time.LocalDate;
+import java.time.LocalTime;
+import java.time.Period;
+import java.time.ZoneId;
 import java.time.temporal.ChronoField;
-import java.time.temporal.ChronoLocalDate;
+import java.time.temporal.TemporalQuery;
+import java.time.temporal.TemporalAccessor;
+import java.time.temporal.TemporalAdjuster;
+import java.time.temporal.TemporalAmount;
 import java.time.temporal.TemporalField;
+import java.time.temporal.TemporalUnit;
 import java.time.temporal.ValueRange;
 import java.util.Objects;
 
 /**
  * A date in the Thai Buddhist calendar system.
  * <p>
- * This implements {@code ChronoLocalDate} for the {@link ThaiBuddhistChrono Thai Buddhist calendar}.
+ * This date operates using the {@linkplain ThaiBuddhistChronology Thai Buddhist calendar}.
+ * This calendar system is primarily used in Thailand.
+ * Dates are aligned such that {@code 2484-01-01 (Buddhist)} is {@code 1941-01-01 (ISO)}.
  *
  * <h3>Specification for implementors</h3>
  * This class is immutable and thread-safe.
  *
  * @since 1.8
  */
-final class ThaiBuddhistDate
-        extends ChronoDateImpl<ThaiBuddhistChrono>
-        implements ChronoLocalDate<ThaiBuddhistChrono>, Serializable {
-    // this class is package-scoped so that future conversion to public
-    // would not change serialization
+public final class ThaiBuddhistDate
+        extends ChronoDateImpl<ThaiBuddhistDate>
+        implements ChronoLocalDate<ThaiBuddhistDate>, Serializable {
 
     /**
      * Serialization version.
      */
     private static final long serialVersionUID = -8722293800195731463L;

@@ -97,10 +105,97 @@
     /**
      * The underlying date.
      */
     private final LocalDate isoDate;
 
+    //-----------------------------------------------------------------------
+    /**
+     * Obtains the current {@code ThaiBuddhistDate} from the system clock in the default time-zone.
+     * <p>
+     * This will query the {@link Clock#systemDefaultZone() system clock} in the default
+     * time-zone to obtain the current date.
+     * <p>
+     * Using this method will prevent the ability to use an alternate clock for testing
+     * because the clock is hard-coded.
+     *
+     * @return the current date using the system clock and default time-zone, not null
+     */
+    public static ThaiBuddhistDate now() {
+        return now(Clock.systemDefaultZone());
+    }
+
+    /**
+     * Obtains the current {@code ThaiBuddhistDate} from the system clock in the specified time-zone.
+     * <p>
+     * This will query the {@link Clock#system(ZoneId) system clock} to obtain the current date.
+     * Specifying the time-zone avoids dependence on the default time-zone.
+     * <p>
+     * Using this method will prevent the ability to use an alternate clock for testing
+     * because the clock is hard-coded.
+     *
+     * @param zone  the zone ID to use, not null
+     * @return the current date using the system clock, not null
+     */
+    public static ThaiBuddhistDate now(ZoneId zone) {
+        return now(Clock.system(zone));
+    }
+
+    /**
+     * Obtains the current {@code ThaiBuddhistDate} from the specified clock.
+     * <p>
+     * This will query the specified clock to obtain the current date - today.
+     * Using this method allows the use of an alternate clock for testing.
+     * The alternate clock may be introduced using {@linkplain Clock dependency injection}.
+     *
+     * @param clock  the clock to use, not null
+     * @return the current date, not null
+     * @throws DateTimeException if the current date cannot be obtained
+     */
+    public static ThaiBuddhistDate now(Clock clock) {
+        return ThaiBuddhistChronology.INSTANCE.date(LocalDate.now(clock));
+    }
+
+    /**
+     * Obtains a {@code ThaiBuddhistDate} representing a date in the Thai Buddhist calendar
+     * system from the proleptic-year, month-of-year and day-of-month fields.
+     * <p>
+     * This returns a {@code ThaiBuddhistDate} with the specified fields.
+     * The day must be valid for the year and month, otherwise an exception will be thrown.
+     *
+     * @param prolepticYear  the Thai Buddhist proleptic-year
+     * @param month  the Thai Buddhist month-of-year, from 1 to 12
+     * @param dayOfMonth  the Thai Buddhist day-of-month, from 1 to 31
+     * @return the date in Thai Buddhist calendar system, not null
+     * @throws DateTimeException if the value of any field is out of range,
+     *  or if the day-of-month is invalid for the month-year
+     */
+    public static ThaiBuddhistDate of(int prolepticYear, int month, int dayOfMonth) {
+        return new ThaiBuddhistDate(LocalDate.of(prolepticYear - YEARS_DIFFERENCE, month, dayOfMonth));
+    }
+
+    /**
+     * Obtains a {@code ThaiBuddhistDate} from a temporal object.
+     * <p>
+     * This obtains a date in the Thai Buddhist calendar system based on the specified temporal.
+     * A {@code TemporalAccessor} represents an arbitrary set of date and time information,
+     * which this factory converts to an instance of {@code ThaiBuddhistDate}.
+     * <p>
+     * The conversion typically uses the {@link ChronoField#EPOCH_DAY EPOCH_DAY}
+     * field, which is standardized across calendar systems.
+     * <p>
+     * This method matches the signature of the functional interface {@link TemporalQuery}
+     * allowing it to be used as a query via method reference, {@code ThaiBuddhistDate::from}.
+     *
+     * @param temporal  the temporal object to convert, not null
+     * @return the date in Thai Buddhist calendar system, not null
+     * @throws DateTimeException if unable to convert to a {@code ThaiBuddhistDate}
+     */
+    public static ThaiBuddhistDate from(TemporalAccessor temporal) {
+        return ThaiBuddhistChronology.INSTANCE.date(temporal);
+    }
+
+    //-----------------------------------------------------------------------
     /**
      * Creates an instance from an ISO date.
      *
      * @param isoDate  the standard local date, validated not null
      */

@@ -109,12 +204,12 @@
         this.isoDate = isoDate;
     }
 
     //-----------------------------------------------------------------------
     @Override
-    public ThaiBuddhistChrono getChrono() {
-        return ThaiBuddhistChrono.INSTANCE;
+    public ThaiBuddhistChronology getChronology() {
+        return ThaiBuddhistChronology.INSTANCE;
     }
 
     @Override
     public int lengthOfMonth() {
         return isoDate.lengthOfMonth();

@@ -134,15 +229,15 @@
                         ValueRange range = YEAR.range();
                         long max = (getProlepticYear() <= 0 ? -(range.getMinimum() + YEARS_DIFFERENCE) + 1 : range.getMaximum() + YEARS_DIFFERENCE);
                         return ValueRange.of(1, max);
                     }
                 }
-                return getChrono().range(f);
+                return getChronology().range(f);
             }
             throw new DateTimeException("Unsupported field: " + field.getName());
         }
-        return field.doRange(this);
+        return field.rangeRefinedBy(this);
     }
 
     @Override
     public long getLong(TemporalField field) {
         if (field instanceof ChronoField) {

@@ -156,11 +251,11 @@
                 case ERA:
                     return (getProlepticYear() >= 1 ? 1 : 0);
             }
             return isoDate.getLong(field);
         }
-        return field.doGet(this);
+        return field.getFrom(this);
     }
 
     private int getProlepticYear() {
         return isoDate.getYear() + YEARS_DIFFERENCE;
     }

@@ -192,10 +287,40 @@
             return with(isoDate.with(field, newValue));
         }
         return (ThaiBuddhistDate) ChronoLocalDate.super.with(field, newValue);
     }
 
+    /**
+     * {@inheritDoc}
+     * @throws DateTimeException {@inheritDoc}
+     * @throws ArithmeticException {@inheritDoc}
+     */
+    @Override
+    public  ThaiBuddhistDate with(TemporalAdjuster adjuster) {
+        return (ThaiBuddhistDate)super.with(adjuster);
+    }
+
+    /**
+     * {@inheritDoc}
+     * @throws DateTimeException {@inheritDoc}
+     * @throws ArithmeticException {@inheritDoc}
+     */
+    @Override
+    public ThaiBuddhistDate plus(TemporalAmount amount) {
+        return (ThaiBuddhistDate)super.plus(amount);
+    }
+
+    /**
+     * {@inheritDoc}
+     * @throws DateTimeException {@inheritDoc}
+     * @throws ArithmeticException {@inheritDoc}
+     */
+    @Override
+    public ThaiBuddhistDate minus(TemporalAmount amount) {
+        return (ThaiBuddhistDate)super.minus(amount);
+    }
+
     //-----------------------------------------------------------------------
     @Override
     ThaiBuddhistDate plusYears(long years) {
         return with(isoDate.plusYears(years));
     }

@@ -204,18 +329,63 @@
     ThaiBuddhistDate plusMonths(long months) {
         return with(isoDate.plusMonths(months));
     }
 
     @Override
+    ThaiBuddhistDate plusWeeks(long weeksToAdd) {
+        return (ThaiBuddhistDate)super.plusWeeks(weeksToAdd);
+    }
+
+    @Override
     ThaiBuddhistDate plusDays(long days) {
         return with(isoDate.plusDays(days));
     }
 
+    @Override
+    public ThaiBuddhistDate plus(long amountToAdd, TemporalUnit unit) {
+        return (ThaiBuddhistDate)super.plus(amountToAdd, unit);
+    }
+
+    @Override
+    public ThaiBuddhistDate minus(long amountToAdd, TemporalUnit unit) {
+        return (ThaiBuddhistDate)super.minus(amountToAdd, unit);
+    }
+
+    @Override
+    ThaiBuddhistDate minusYears(long yearsToSubtract) {
+        return (ThaiBuddhistDate)super.minusYears(yearsToSubtract);
+    }
+
+    @Override
+    ThaiBuddhistDate minusMonths(long monthsToSubtract) {
+        return (ThaiBuddhistDate)super.minusMonths(monthsToSubtract);
+    }
+
+    @Override
+    ThaiBuddhistDate minusWeeks(long weeksToSubtract) {
+        return (ThaiBuddhistDate)super.minusWeeks(weeksToSubtract);
+    }
+
+    @Override
+    ThaiBuddhistDate minusDays(long daysToSubtract) {
+        return (ThaiBuddhistDate)super.minusDays(daysToSubtract);
+    }
+
     private ThaiBuddhistDate with(LocalDate newDate) {
         return (newDate.equals(isoDate) ? this : new ThaiBuddhistDate(newDate));
     }
 
+    @Override        // for javadoc and covariant return type
+    public final ChronoLocalDateTime<ThaiBuddhistDate> atTime(LocalTime localTime) {
+        return (ChronoLocalDateTime<ThaiBuddhistDate>)super.atTime(localTime);
+    }
+
+    @Override
+    public Period periodUntil(ChronoLocalDate<?> endDate) {
+        return isoDate.periodUntil(endDate);
+    }
+
     @Override  // override for performance
     public long toEpochDay() {
         return isoDate.toEpochDay();
     }
 

@@ -232,28 +402,28 @@
         return false;
     }
 
     @Override  // override for performance
     public int hashCode() {
-        return getChrono().getId().hashCode() ^ isoDate.hashCode();
+        return getChronology().getId().hashCode() ^ isoDate.hashCode();
     }
 
     //-----------------------------------------------------------------------
     private Object writeReplace() {
         return new Ser(Ser.THAIBUDDHIST_DATE_TYPE, this);
     }
 
     void writeExternal(DataOutput out) throws IOException {
-        // MinguoChrono is implicit in the THAIBUDDHIST_DATE_TYPE
+        // ThaiBuddhistChronology is implicit in the THAIBUDDHIST_DATE_TYPE
         out.writeInt(this.get(YEAR));
         out.writeByte(this.get(MONTH_OF_YEAR));
         out.writeByte(this.get(DAY_OF_MONTH));
     }
 
-    static ChronoLocalDate<ThaiBuddhistChrono> readExternal(DataInput in) throws IOException {
+    static ThaiBuddhistDate readExternal(DataInput in) throws IOException {
         int year = in.readInt();
         int month = in.readByte();
         int dayOfMonth = in.readByte();
-        return ThaiBuddhistChrono.INSTANCE.date(year, month, dayOfMonth);
+        return ThaiBuddhistChronology.INSTANCE.date(year, month, dayOfMonth);
     }
 
 }