@sitevision/api 2023.2.1 → 2023.2.2-beta.2

package/types/java/time/ZoneId/index.d.ts

@@ -0,0 +1,223 @@
+import type { String } from "../../lang/String";
+import type { TextStyle } from "../format/TextStyle";
+import type { Locale } from "../../util/Locale";
+import type { ZoneRules } from "../zone/ZoneRules";
+import type { Object } from "../../lang/Object";
+
+import type { Serializable } from "../../io/Serializable";
+import type { Map } from "../../util/Map";
+
+/**
+ * A time-zone ID, such as {@code Europe/Paris}.
+ *  <p>
+ *  A {@code ZoneId} is used to identify the rules used to convert between
+ *  an {@link Instant} and a {@link LocalDateTime}.
+ *  There are two distinct types of ID:
+ *  <ul>
+ *  <li>Fixed offsets - a fully resolved offset from UTC/Greenwich, that uses
+ *   the same offset for all local date-times
+ *  <li>Geographical regions - an area where a specific set of rules for finding
+ *   the offset from UTC/Greenwich apply
+ *  </ul>
+ *  Most fixed offsets are represented by {@link ZoneOffset}.
+ *  Calling {@link #normalized()} on any {@code ZoneId} will ensure that a
+ *  fixed offset ID will be represented as a {@code ZoneOffset}.
+ *  <p>
+ *  The actual rules, describing when and how the offset changes, are defined by {@link ZoneRules}.
+ *  This class is simply an ID used to obtain the underlying rules.
+ *  This approach is taken because rules are defined by governments and change
+ *  frequently, whereas the ID is stable.
+ *  <p>
+ *  The distinction has other effects. Serializing the {@code ZoneId} will only send
+ *  the ID, whereas serializing the rules sends the entire data set.
+ *  Similarly, a comparison of two IDs only examines the ID, whereas
+ *  a comparison of two rules examines the entire data set.
+ *
+ *  <h3>Time-zone IDs</h3>
+ *  The ID is unique within the system.
+ *  There are three types of ID.
+ *  <p>
+ *  The simplest type of ID is that from {@code ZoneOffset}.
+ *  This consists of 'Z' and IDs starting with '+' or '-'.
+ *  <p>
+ *  The next type of ID are offset-style IDs with some form of prefix,
+ *  such as 'GMT+2' or 'UTC+01:00'.
+ *  The recognised prefixes are 'UTC', 'GMT' and 'UT'.
+ *  The offset is the suffix and will be normalized during creation.
+ *  These IDs can be normalized to a {@code ZoneOffset} using {@code normalized()}.
+ *  <p>
+ *  The third type of ID are region-based IDs. A region-based ID must be of
+ *  two or more characters, and not start with 'UTC', 'GMT', 'UT' '+' or '-'.
+ *  Region-based IDs are defined by configuration, see {@link ZoneRulesProvider}.
+ *  The configuration focuses on providing the lookup from the ID to the
+ *  underlying {@code ZoneRules}.
+ *  <p>
+ *  Time-zone rules are defined by governments and change frequently.
+ *  There are a number of organizations, known here as groups, that monitor
+ *  time-zone changes and collate them.
+ *  The default group is the IANA Time Zone Database (TZDB).
+ *  Other organizations include IATA (the airline industry body) and Microsoft.
+ *  <p>
+ *  Each group defines its own format for the region ID it provides.
+ *  The TZDB group defines IDs such as 'Europe/London' or 'America/New_York'.
+ *  TZDB IDs take precedence over other groups.
+ *  <p>
+ *  It is strongly recommended that the group name is included in all IDs supplied by
+ *  groups other than TZDB to avoid conflicts. For example, IATA airline time-zone
+ *  region IDs are typically the same as the three letter airport code.
+ *  However, the airport of Utrecht has the code 'UTC', which is obviously a conflict.
+ *  The recommended format for region IDs from groups other than TZDB is 'group~region'.
+ *  Thus if IATA data were defined, Utrecht airport would be 'IATA~UTC'.
+ *
+ *  <h3>Serialization</h3>
+ *  This class can be serialized and stores the string zone ID in the external form.
+ *  The {@code ZoneOffset} subclass uses a dedicated format that only stores the
+ *  offset from UTC/Greenwich.
+ *  <p>
+ *  A {@code ZoneId} can be deserialized in a Java Runtime where the ID is unknown.
+ *  For example, if a server-side Java Runtime has been updated with a new zone ID, but
+ *  the client-side Java Runtime has not been updated. In this case, the {@code ZoneId}
+ *  object will exist, and can be queried using {@code getId}, {@code equals},
+ *  {@code hashCode}, {@code toString}, {@code getDisplayName} and {@code normalized}.
+ *  However, any call to {@code getRules} will fail with {@code ZoneRulesException}.
+ *  This approach is designed to allow a {@link ZonedDateTime} to be loaded and
+ *  queried, but not modified, on a Java Runtime with incomplete time-zone information.
+ *
+ *  <p>
+ *  This is a <a href="{@docRoot}/java/lang/doc-files/ValueBased.html">value-based</a>
+ *  class; use of identity-sensitive operations (including reference equality
+ *  ({@code ==}), identity hash code, or synchronization) on instances of
+ *  {@code ZoneId} may have unpredictable results and should be avoided.
+ *  The {@code equals} method should be used for comparisons.
+ * @implSpec This abstract class has two implementations, both of which are immutable and thread-safe.&#xA; One implementation models region-based IDs, the other is {@code ZoneOffset} modelling&#xA; offset-based IDs. This difference is visible in serialization.
+ * @since 1.8
+ */
+export type ZoneId = Object &
+  Serializable & {
+    /**
+     * Gets the unique time-zone ID.
+     *  <p>
+     *  This ID uniquely defines this object.
+     *  The format of an offset based ID is defined by {@link ZoneOffset#getId()}.
+     * @return the time-zone unique ID, not null
+     */
+    getId(): string;
+
+    /**
+     * Gets the textual representation of the zone, such as 'British Time' or
+     *  '+02:00'.
+     *  <p>
+     *  This returns the textual name used to identify the time-zone ID,
+     *  suitable for presentation to the user.
+     *  The parameters control the style of the returned text and the locale.
+     *  <p>
+     *  If no textual mapping is found then the {@link #getId() full ID} is returned.
+     * @param style the length of the text required, not null
+     * @param locale the locale to use, not null
+     * @return the text value of the zone, not null
+     */
+    getDisplayName(style: TextStyle, locale: Locale): string;
+
+    /**
+     * Gets the time-zone rules for this ID allowing calculations to be performed.
+     *  <p>
+     *  The rules provide the functionality associated with a time-zone,
+     *  such as finding the offset for a given instant or local date-time.
+     *  <p>
+     *  A time-zone can be invalid if it is deserialized in a Java Runtime which
+     *  does not have the same rules loaded as the Java Runtime that stored it.
+     *  In this case, calling this method will throw a {@code ZoneRulesException}.
+     *  <p>
+     *  The rules are supplied by {@link ZoneRulesProvider}. An advanced provider may
+     *  support dynamic updates to the rules without restarting the Java Runtime.
+     *  If so, then the result of this method may change over time.
+     *  Each individual call will be still remain thread-safe.
+     *  <p>
+     *  {@link ZoneOffset} will always return a set of rules where the offset never changes.
+     * @return the rules, not null
+     * @throws ZoneRulesException if no rules are available for this ID
+     */
+    getRules(): ZoneRules;
+
+    /**
+     * Normalizes the time-zone ID, returning a {@code ZoneOffset} where possible.
+     *  <p>
+     *  The returns a normalized {@code ZoneId} that can be used in place of this ID.
+     *  The result will have {@code ZoneRules} equivalent to those returned by this object,
+     *  however the ID returned by {@code getId()} may be different.
+     *  <p>
+     *  The normalization checks if the rules of this {@code ZoneId} have a fixed offset.
+     *  If they do, then the {@code ZoneOffset} equal to that offset is returned.
+     *  Otherwise {@code this} is returned.
+     * @return the time-zone unique ID, not null
+     */
+    normalized(): ZoneId;
+
+    /**
+     * Checks if this time-zone ID is equal to another time-zone ID.
+     *  <p>
+     *  The comparison is based on the ID.
+     * @param obj the object to check, null returns false
+     * @return true if this is equal to the other time-zone ID
+     */
+    equals(obj: unknown): boolean;
+
+    /**
+     * A hash code for this time-zone ID.
+     * @return a suitable hash code
+     */
+    hashCode(): number;
+
+    /**
+     * Outputs this zone as a {@code String}, using the ID.
+     * @return a string representation of this time-zone ID, not null
+     */
+    toString(): string;
+
+    /**
+ * A map of zone overrides to enable the short time-zone names to be used.
+ *  <p>
+ *  Use of short zone IDs has been deprecated in {@code java.util.TimeZone}.
+ *  This map allows the IDs to continue to be used via the
+ *  {@link #of(String, Map)} factory method.
+ *  <p>
+ *  This map contains a mapping of the IDs that is in line with TZDB 2005r and
+ *  later, where 'EST', 'MST' and 'HST' map to IDs which do not include daylight
+ *  savings.
+ *  <p>
+ *  This maps as follows:
+ *  <ul>
+ *  <li>EST - -05:00</li>
+ *  <li>HST - -10:00</li>
+ *  <li>MST - -07:00</li>
+ *  <li>ACT - Australia/Darwin</li>
+ *  <li>AET - Australia/Sydney</li>
+ *  <li>AGT - America/Argentina/Buenos_Aires</li>
+ *  <li>ART - Africa/Cairo</li>
+ *  <li>AST - America/Anchorage</li>
+ *  <li>BET - America/Sao_Paulo</li>
+ *  <li>BST - Asia/Dhaka</li>
+ *  <li>CAT - Africa/Harare</li>
+ *  <li>CNT - America/St_Johns</li>
+ *  <li>CST - America/Chicago</li>
+ *  <li>CTT - Asia/Shanghai</li>
+ *  <li>EAT - Africa/Addis_Ababa</li>
+ *  <li>ECT - Europe/Paris</li>
+ *  <li>IET - America/Indiana/Indianapolis</li>
+ *  <li>IST - Asia/Kolkata</li>
+ *  <li>JST - Asia/Tokyo</li>
+ *  <li>MIT - Pacific/Apia</li>
+ *  <li>NET - Asia/Yerevan</li>
+ *  <li>NST - Pacific/Auckland</li>
+ *  <li>PLT - Asia/Karachi</li>
+ *  <li>PNT - America/Phoenix</li>
+ *  <li>PRT - America/Puerto_Rico</li>
+ *  <li>PST - America/Los_Angeles</li>
+ *  <li>SST - Pacific/Guadalcanal</li>
+ *  <li>VST - Asia/Ho_Chi_Minh</li>
+ *  </ul>
+ *  The map is unmodifiable.
+  
+    */
+    SHORT_IDS: Map;
+  };

package/types/java/time/ZoneId/index.js

@@ -0,0 +1,16 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _default = {
+  getId: function getId() {},
+  getDisplayName: function getDisplayName() {},
+  getRules: function getRules() {},
+  normalized: function normalized() {},
+  equals: function equals() {},
+  hashCode: function hashCode() {},
+  toString: function toString() {}
+};
+exports["default"] = _default;

package/types/java/time/ZoneOffset/index.d.ts

@@ -0,0 +1,281 @@
+import type { String } from "../../lang/String";
+import type { ZoneRules } from "../zone/ZoneRules";
+import type { TemporalField } from "../temporal/TemporalField";
+
+import type { ValueRange } from "../temporal/ValueRange";
+
+import type { TemporalQuery } from "../temporal/TemporalQuery";
+
+import type { Temporal } from "../temporal/Temporal";
+import type { Object } from "../../lang/Object";
+import type { ZoneId } from "../ZoneId";
+import type { TemporalAccessor } from "../temporal/TemporalAccessor";
+import type { TemporalAdjuster } from "../temporal/TemporalAdjuster";
+import type { Comparable } from "../../lang/Comparable";
+import type { Serializable } from "../../io/Serializable";
+
+/**
+ * A time-zone offset from Greenwich/UTC, such as {@code +02:00}.
+ *  <p>
+ *  A time-zone offset is the amount of time that a time-zone differs from Greenwich/UTC.
+ *  This is usually a fixed number of hours and minutes.
+ *  <p>
+ *  Different parts of the world have different time-zone offsets.
+ *  The rules for how offsets vary by place and time of year are captured in the
+ *  {@link ZoneId} class.
+ *  <p>
+ *  For example, Paris is one hour ahead of Greenwich/UTC in winter and two hours
+ *  ahead in summer. The {@code ZoneId} instance for Paris will reference two
+ *  {@code ZoneOffset} instances - a {@code +01:00} instance for winter,
+ *  and a {@code +02:00} instance for summer.
+ *  <p>
+ *  In 2008, time-zone offsets around the world extended from -12:00 to +14:00.
+ *  To prevent any problems with that range being extended, yet still provide
+ *  validation, the range of offsets is restricted to -18:00 to 18:00 inclusive.
+ *  <p>
+ *  This class is designed for use with the ISO calendar system.
+ *  The fields of hours, minutes and seconds make assumptions that are valid for the
+ *  standard ISO definitions of those fields. This class may be used with other
+ *  calendar systems providing the definition of the time fields matches those
+ *  of the ISO calendar system.
+ *  <p>
+ *  Instances of {@code ZoneOffset} must be compared using {@link #equals}.
+ *  Implementations may choose to cache certain common offsets, however
+ *  applications must not rely on such caching.
+ *
+ *  <p>
+ *  This is a <a href="{@docRoot}/java/lang/doc-files/ValueBased.html">value-based</a>
+ *  class; use of identity-sensitive operations (including reference equality
+ *  ({@code ==}), identity hash code, or synchronization) on instances of
+ *  {@code ZoneOffset} may have unpredictable results and should be avoided.
+ *  The {@code equals} method should be used for comparisons.
+ * @implSpec This class is immutable and thread-safe.
+ * @since 1.8
+ */
+export type ZoneOffset = ZoneId &
+  TemporalAccessor &
+  TemporalAdjuster &
+  Comparable &
+  Serializable & {
+    /**
+     * Gets the total zone offset in seconds.
+     *  <p>
+     *  This is the primary way to access the offset amount.
+     *  It returns the total of the hours, minutes and seconds fields as a
+     *  single offset that can be added to a time.
+     * @return the total zone offset amount in seconds
+     */
+    getTotalSeconds(): number;
+
+    /**
+     * Gets the normalized zone offset ID.
+     *  <p>
+     *  The ID is minor variation to the standard ISO-8601 formatted string
+     *  for the offset. There are three formats:
+     *  <ul>
+     *  <li>{@code Z} - for UTC (ISO-8601)
+     *  <li>{@code +hh:mm} or {@code -hh:mm} - if the seconds are zero (ISO-8601)
+     *  <li>{@code +hh:mm:ss} or {@code -hh:mm:ss} - if the seconds are non-zero (not ISO-8601)
+     *  </ul>
+     * @return the zone offset ID, not null
+     */
+    getId(): string;
+
+    /**
+     * Gets the associated time-zone rules.
+     *  <p>
+     *  The rules will always return this offset when queried.
+     *  The implementation class is immutable, thread-safe and serializable.
+     * @return the rules, not null
+     */
+    getRules(): ZoneRules;
+
+    /**
+     * Checks if the specified field is supported.
+     *  <p>
+     *  This checks if this offset can be queried for the specified field.
+     *  If false, then calling the {@link #range(TemporalField) range} and
+     *  {@link #get(TemporalField) get} methods will throw an exception.
+     *  <p>
+     *  If the field is a {@link ChronoField} then the query is implemented here.
+     *  The {@code OFFSET_SECONDS} field returns true.
+     *  All other {@code ChronoField} instances will return false.
+     *  <p>
+     *  If the field is not a {@code ChronoField}, then the result of this method
+     *  is obtained by invoking {@code TemporalField.isSupportedBy(TemporalAccessor)}
+     *  passing {@code this} as the argument.
+     *  Whether the field is supported is determined by the field.
+     * @param field the field to check, null returns false
+     * @return true if the field is supported on this offset, false if not
+     */
+    isSupported(field: TemporalField): boolean;
+
+    /**
+     * Gets the range of valid values for the specified field.
+     *  <p>
+     *  The range object expresses the minimum and maximum valid values for a field.
+     *  This offset is used to enhance the accuracy of the returned range.
+     *  If it is not possible to return the range, because the field is not supported
+     *  or for some other reason, an exception is thrown.
+     *  <p>
+     *  If the field is a {@link ChronoField} then the query is implemented here.
+     *  The {@link #isSupported(TemporalField) supported fields} will return
+     *  appropriate range instances.
+     *  All other {@code ChronoField} instances will throw an {@code UnsupportedTemporalTypeException}.
+     *  <p>
+     *  If the field is not a {@code ChronoField}, then the result of this method
+     *  is obtained by invoking {@code TemporalField.rangeRefinedBy(TemporalAccessor)}
+     *  passing {@code this} as the argument.
+     *  Whether the range can be obtained is determined by the field.
+     * @param field the field to query the range for, not null
+     * @return the range of valid values for the field, not null
+     * @throws DateTimeException if the range for the field cannot be obtained
+     * @throws UnsupportedTemporalTypeException if the field is not supported
+     */
+    range(field: TemporalField): ValueRange;
+
+    /**
+     * Gets the value of the specified field from this offset as an {@code int}.
+     *  <p>
+     *  This queries this offset for the value of the specified field.
+     *  The returned value will always be within the valid range of values for the field.
+     *  If it is not possible to return the value, because the field is not supported
+     *  or for some other reason, an exception is thrown.
+     *  <p>
+     *  If the field is a {@link ChronoField} then the query is implemented here.
+     *  The {@code OFFSET_SECONDS} field returns the value of the offset.
+     *  All other {@code ChronoField} instances will throw an {@code UnsupportedTemporalTypeException}.
+     *  <p>
+     *  If the field is not a {@code ChronoField}, then the result of this method
+     *  is obtained by invoking {@code TemporalField.getFrom(TemporalAccessor)}
+     *  passing {@code this} as the argument. Whether the value can be obtained,
+     *  and what the value represents, is determined by the field.
+     * @param field the field to get, not null
+     * @return the value for the field
+     * @throws DateTimeException if a value for the field cannot be obtained or&#xA; the value is outside the range of valid values for the field
+     * @throws UnsupportedTemporalTypeException if the field is not supported or&#xA; the range of values exceeds an {@code int}
+     * @throws ArithmeticException if numeric overflow occurs
+     */
+    get(field: TemporalField): number;
+
+    /**
+     * Gets the value of the specified field from this offset as a {@code long}.
+     *  <p>
+     *  This queries this offset for the value of the specified field.
+     *  If it is not possible to return the value, because the field is not supported
+     *  or for some other reason, an exception is thrown.
+     *  <p>
+     *  If the field is a {@link ChronoField} then the query is implemented here.
+     *  The {@code OFFSET_SECONDS} field returns the value of the offset.
+     *  All other {@code ChronoField} instances will throw an {@code UnsupportedTemporalTypeException}.
+     *  <p>
+     *  If the field is not a {@code ChronoField}, then the result of this method
+     *  is obtained by invoking {@code TemporalField.getFrom(TemporalAccessor)}
+     *  passing {@code this} as the argument. Whether the value can be obtained,
+     *  and what the value represents, is determined by the field.
+     * @param field the field to get, not null
+     * @return the value for the field
+     * @throws DateTimeException if a value for the field cannot be obtained
+     * @throws UnsupportedTemporalTypeException if the field is not supported
+     * @throws ArithmeticException if numeric overflow occurs
+     */
+    getLong(field: TemporalField): number;
+
+    /**
+     * Queries this offset using the specified query.
+     *  <p>
+     *  This queries this offset using the specified query strategy object.
+     *  The {@code TemporalQuery} object defines the logic to be used to
+     *  obtain the result. Read the documentation of the query to understand
+     *  what the result of this method will be.
+     *  <p>
+     *  The result of this method is obtained by invoking the
+     *  {@link TemporalQuery#queryFrom(TemporalAccessor)} method on the
+     *  specified query passing {@code this} as the argument.
+     * @param <R> the type of the result
+     * @param query the query to invoke, not null
+     * @return the query result, null may be returned (defined by the query)
+     * @throws DateTimeException if unable to query (defined by the query)
+     * @throws ArithmeticException if numeric overflow occurs (defined by the query)
+     */
+    query(query: TemporalQuery): unknown;
+
+    /**
+     * Adjusts the specified temporal object to have the same offset as this object.
+     *  <p>
+     *  This returns a temporal object of the same observable type as the input
+     *  with the offset changed to be the same as this.
+     *  <p>
+     *  The adjustment is equivalent to using {@link Temporal#with(TemporalField, long)}
+     *  passing {@link ChronoField#OFFSET_SECONDS} as the field.
+     *  <p>
+     *  In most cases, it is clearer to reverse the calling pattern by using
+     *  {@link Temporal#with(TemporalAdjuster)}:
+     *  <pre>
+     *    // these two lines are equivalent, but the second approach is recommended
+     *    temporal = thisOffset.adjustInto(temporal);
+     *    temporal = temporal.with(thisOffset);
+     *  </pre>
+     *  <p>
+     *  This instance is immutable and unaffected by this method call.
+     * @param temporal the target object to be adjusted, not null
+     * @return the adjusted object, not null
+     * @throws DateTimeException if unable to make the adjustment
+     * @throws ArithmeticException if numeric overflow occurs
+     */
+    adjustInto(temporal: Temporal): Temporal;
+
+    /**
+     * Compares this offset to another offset in descending order.
+     *  <p>
+     *  The offsets are compared in the order that they occur for the same time
+     *  of day around the world. Thus, an offset of {@code +10:00} comes before an
+     *  offset of {@code +09:00} and so on down to {@code -18:00}.
+     *  <p>
+     *  The comparison is "consistent with equals", as defined by {@link Comparable}.
+     * @param other the other date to compare to, not null
+     * @return the comparator value, negative if less, positive if greater
+     * @throws NullPointerException if {@code other} is null
+     */
+    compareTo(other: ZoneOffset): number;
+
+    /**
+     * Checks if this offset is equal to another offset.
+     *  <p>
+     *  The comparison is based on the amount of the offset in seconds.
+     *  This is equivalent to a comparison by ID.
+     * @param obj the object to check, null returns false
+     * @return true if this is equal to the other offset
+     */
+    equals(obj: unknown): boolean;
+
+    /**
+     * A hash code for this offset.
+     * @return a suitable hash code
+     */
+    hashCode(): number;
+
+    /**
+     * Outputs this offset as a {@code String}, using the normalized ID.
+     * @return a string representation of this offset, not null
+     */
+    toString(): string;
+
+    /**
+ * The time-zone offset for UTC, with an ID of 'Z'.
+  
+    */
+    UTC: ZoneOffset;
+
+    /**
+ * Constant for the maximum supported offset.
+  
+    */
+    MIN: ZoneOffset;
+
+    /**
+ * Constant for the maximum supported offset.
+  
+    */
+    MAX: ZoneOffset;
+  };

package/types/java/time/ZoneOffset/index.js

@@ -0,0 +1,22 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _default = {
+  getTotalSeconds: function getTotalSeconds() {},
+  getId: function getId() {},
+  getRules: function getRules() {},
+  isSupported: function isSupported() {},
+  range: function range() {},
+  get: function get() {},
+  getLong: function getLong() {},
+  query: function query() {},
+  adjustInto: function adjustInto() {},
+  compareTo: function compareTo() {},
+  equals: function equals() {},
+  hashCode: function hashCode() {},
+  toString: function toString() {}
+};
+exports["default"] = _default;