OpenJDK 27 · java.time.ZoneOffset · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
private final transient String	id The string form of the time-zone offset.
private static final ConcurrentMap<String, ZoneOffset>	ID_CACHE Cache of time-zone offset by ID.
public static final ZoneOffset	MAX Constant for the maximum supported offset.
private static final int	MAX_SECONDS The abs maximum seconds.
public static final ZoneOffset	MIN Constant for the minimum supported offset.
private static final AtomicReferenceArray<ZoneOffset>	QUARTER_CACHE
private final transient LazyConstant<ZoneRules>	rules The zone rules for an offset will always return this offset.
private static final int	SECONDS_PER_QUARTER Cache of time-zone offset by offset in quarters.
private static final long	serialVersionUID Hides java.time.ZoneId.serialVersionUID. Serialization version.
private final int	totalSeconds
public static final ZoneOffset	UTC The time-zone offset for UTC, with an ID of 'Z'.

Access	Constructor and Description
private	ZoneOffset(int the total time-zone offset in seconds, from -64,800 to +64,800 totalSeconds) Constructor.

Method Summary

Modifier and Type	Method and Description
public Temporal	Returns: the adjusted object, not null adjustInto(Temporal the target object to be adjusted, not null temporal) Implements java.time.temporal.TemporalAdjuster.adjustInto. Adjusts the specified temporal object to have the same offset as this object.
private static String	buildId(int totalSeconds)
public int	Returns: the comparator value, that is less than zero if this totalSeconds is less than `other` totalSeconds, zero if they are equal, greater than zero if this totalSeconds is greater than `other` totalSeconds compareTo(ZoneOffset the other date to compare to, not null other) Implements java.lang.Comparable.compareTo. Compares this offset to another offset in descending order.
public boolean	Returns: true if this is equal to the other offset equals(Object the object to check, null returns false obj) Overrides java.time.ZoneId.equals. Checks if this offset is equal to another offset.
public static ZoneOffset	Returns: the zone-offset, not null from(TemporalAccessor the temporal object to convert, not null temporal) Hides java.time.ZoneId.from. Obtains an instance of `ZoneOffset` from a temporal object.
public int	Returns: the value for the field get(TemporalField the field to get, not null field) Overrides default java.time.temporal.TemporalAccessor.get. Gets the value of the specified field from this offset as an `int`.
public String	Returns: the zone offset ID, not null getId() Implements abstract java.time.ZoneId.getId. Gets the normalized zone offset ID. The ID is minor variation to the standard ISO-8601 formatted string for the offset.
public long	Returns: the value for the field getLong(TemporalField the field to get, not null field) Implements java.time.temporal.TemporalAccessor.getLong. Gets the value of the specified field from this offset as a `long`.
pack-priv ZoneOffset	getOffset(long epochSecond) Implements abstract java.time.ZoneId.getOffset. Get the effective offset for an instant at the given epochSecond.
public ZoneRules	Returns: the rules, not null getRules() Implements abstract java.time.ZoneId.getRules. Gets the associated time-zone rules.
public int	Returns: the total zone offset amount in seconds getTotalSeconds() Gets the total zone offset in seconds.
public int	Returns: a suitable hash code hashCode() Overrides java.time.ZoneId.hashCode. A hash code for this offset.
public boolean	Returns: true if the field is supported on this offset, false if not isSupported(TemporalField the field to check, null returns false field) Implements java.time.temporal.TemporalAccessor.isSupported. Checks if the specified field is supported.
public ZoneId	normalized() Overrides java.time.ZoneId.normalized. Normalizes the time-zone ID, returning a `ZoneOffset` where possible.
public static ZoneOffset	Returns: the zone-offset, not null of(String the offset ID, not null offsetId) Hides java.time.ZoneId.of. Obtains an instance of `ZoneOffset` using the ID. This method parses the string ID of a `ZoneOffset` to return an instance.
public static ZoneOffset	Returns: the zone-offset, not null ofHours(int the time-zone offset in hours, from -18 to +18 hours) Obtains an instance of `ZoneOffset` using an offset in hours.
public static ZoneOffset	Returns: the zone-offset, not null ofHoursMinutes(int the time-zone offset in hours, from -18 to +18 hours, int the time-zone offset in minutes, from 0 to ±59, sign matches hours minutes) Obtains an instance of `ZoneOffset` using an offset in hours and minutes.
public static ZoneOffset	Returns: the zone-offset, not null ofHoursMinutesSeconds(int the time-zone offset in hours, from -18 to +18 hours, int the time-zone offset in minutes, from 0 to ±59, sign matches hours and seconds minutes, int the time-zone offset in seconds, from 0 to ±59, sign matches hours and minutes seconds) Obtains an instance of `ZoneOffset` using an offset in hours, minutes and seconds.
public static ZoneOffset	Returns: the ZoneOffset, not null ofTotalSeconds(int the total time-zone offset in seconds, from -64,800 to +64,800 totalSeconds) Obtains an instance of `ZoneOffset` specifying the total offset in seconds The offset must be in the range `-18:00` to `+18:00`, which corresponds to -64,800 to +64,800.
private static int	Returns: the parsed number, from 0 to 99 parseNumber(CharSequence the offset ID, not null offsetId, int the position to parse, valid pos, boolean should this number be prefixed by a precededByColon precededByColon) Parse a two digit zero-prefixed number.
public < the type of the result R> R	Returns: the query result, null may be returned (defined by the query) query(TemporalQuery<R> the query to invoke, not null query) Overrides default java.time.temporal.TemporalAccessor.query. Queries this offset using the specified query.
public ValueRange	Returns: the range of valid values for the field, not null range(TemporalField the field to query the range for, not null field) Overrides default java.time.temporal.TemporalAccessor.range. Gets the range of valid values for the specified field.
pack-priv static ZoneOffset	readExternal(DataInput in)
private void	readObject(ObjectInputStream the stream to read s) Hides java.time.ZoneId.readObject. Defend against malicious streams.
public String	Returns: a string representation of this offset, not null toString() Overrides java.time.ZoneId.toString. Outputs this offset as a `String`, using the normalized ID.
private static int	Returns: the total in seconds totalSeconds(int the time-zone offset in hours, from -18 to +18 hours, int the time-zone offset in minutes, from 0 to ±59, sign matches hours and seconds minutes, int the time-zone offset in seconds, from 0 to ±59, sign matches hours and minutes seconds) Calculates the total offset in seconds.
private static void	validate(int the time-zone offset in hours, from -18 to +18 hours, int the time-zone offset in minutes, from 0 to ±59 minutes, int the time-zone offset in seconds, from 0 to ±59 seconds) Validates the offset fields.
pack-priv void	write(DataOutput out) Implements abstract java.time.ZoneId.write.
pack-priv void	writeExternal(DataOutput out)
private Object	Returns: the instance of `Ser`, not null writeReplace() Hides java.time.ZoneId.writeReplace. Writes the object using a dedicated serialized form.

Inherited from java.time.ZoneId:: getAvailableZoneIds getDisplayName of of ofOffset systemDefault

id	back to summary
private final transient String id The string form of the time-zone offset.

ID_CACHE	back to summary
private static final ConcurrentMap<String, ZoneOffset> ID_CACHE Cache of time-zone offset by ID.

MAX	back to summary
public static final ZoneOffset MAX Constant for the maximum supported offset.

MAX_SECONDS	back to summary
private static final int MAX_SECONDS The abs maximum seconds.

MIN	back to summary
public static final ZoneOffset MIN Constant for the minimum supported offset.

QUARTER_CACHE	back to summary
private static final AtomicReferenceArray<ZoneOffset> QUARTER_CACHE

rules	back to summary
private final transient LazyConstant<ZoneRules> rules The zone rules for an offset will always return this offset. Cache it for efficiency.

SECONDS_PER_QUARTER	back to summary
private static final int SECONDS_PER_QUARTER Cache of time-zone offset by offset in quarters.

serialVersionUID	back to summary
private static final long serialVersionUID Hides java.time.ZoneId.serialVersionUID. Serialization version. Annotations @Serial

totalSeconds	back to summary
private final int totalSeconds

UTC	back to summary
public static final ZoneOffset UTC The time-zone offset for UTC, with an ID of 'Z'.

ZoneOffset	back to summary
private ZoneOffset(int totalSeconds) Constructor. Parameters totalSeconds:int the total time-zone offset in seconds, from -64,800 to +64,800

Method Detail

adjustInto back to summary

adjustInto	back to summary
public Temporal adjustInto(Temporal temporal) Implements java.time.temporal.TemporalAdjuster.adjustInto. Adjusts the specified temporal object to have the same offset as this object. This returns a temporal object of the same observable type as the input with the offset changed to be the same as this. The adjustment is equivalent to using `Temporal#with(TemporalField, long)` passing `ChronoField#OFFSET_SECONDS` as the field. In most cases, it is clearer to reverse the calling pattern by using `Temporal#with(TemporalAdjuster)`: // these two lines are equivalent, but the second approach is recommended temporal = thisOffset.adjustInto(temporal); temporal = temporal.with(thisOffset); This instance is immutable and unaffected by this method call. Parameters temporal:Temporal the target object to be adjusted, not null Returns:Temporal the adjusted object, not null Annotations @Override Exceptions DateTimeException: if unable to make the adjustment ArithmeticException: if numeric overflow occurs

public Temporal adjustInto(Temporal temporal)

Implements java.time.temporal.TemporalAdjuster.adjustInto.

Adjusts the specified temporal object to have the same offset as this object.

This returns a temporal object of the same observable type as the input with the offset changed to be the same as this.

The adjustment is equivalent to using Temporal#with(TemporalField, long) passing ChronoField#OFFSET_SECONDS as the field.

In most cases, it is clearer to reverse the calling pattern by using Temporal#with(TemporalAdjuster):

  // these two lines are equivalent, but the second approach is recommended
  temporal = thisOffset.adjustInto(temporal);
  temporal = temporal.with(thisOffset);

This instance is immutable and unaffected by this method call.

Parameters

temporal:Temporal: the target object to be adjusted, not null

Returns:Temporal

the adjusted object, not null

Annotations

@Override

Exceptions

DateTimeException:: if unable to make the adjustment
ArithmeticException:: if numeric overflow occurs

buildId	back to summary
private static String buildId(int totalSeconds)

compareTo back to summary

compareTo	back to summary
public int compareTo(ZoneOffset other) Implements java.lang.Comparable.compareTo. Compares this offset to another offset in descending order. The offsets are compared in the order that they occur for the same time of day around the world. Thus, an offset of `+10:00` comes before an offset of `+09:00` and so on down to `-18:00`. The comparison is "consistent with equals", as defined by `Comparable`. Parameters other:ZoneOffset the other date to compare to, not null Returns:int the comparator value, that is less than zero if this totalSeconds is less than `other` totalSeconds, zero if they are equal, greater than zero if this totalSeconds is greater than `other` totalSeconds Annotations @Override Exceptions NullPointerException: if `other` is null

public int compareTo(ZoneOffset other)

Implements java.lang.Comparable.compareTo.

Compares this offset to another offset in descending order.

The offsets are compared in the order that they occur for the same time of day around the world. Thus, an offset of +10:00 comes before an offset of +09:00 and so on down to -18:00.

The comparison is "consistent with equals", as defined by Comparable.

Parameters

other:ZoneOffset: the other date to compare to, not null

Returns:int

the comparator value, that is less than zero if this totalSeconds is less than other totalSeconds, zero if they are equal, greater than zero if this totalSeconds is greater than other totalSeconds

Annotations

@Override

Exceptions

NullPointerException:: if other is null

equals	back to summary
public boolean equals(Object obj) Overrides java.time.ZoneId.equals. Checks if this offset is equal to another offset. The comparison is based on the amount of the offset in seconds. This is equivalent to a comparison by ID. Parameters obj:Object the object to check, null returns false Returns:boolean true if this is equal to the other offset Annotations @Override

equals

back to summary

public boolean equals(Object obj)

Overrides java.time.ZoneId.equals.

Checks if this offset is equal to another offset.

The comparison is based on the amount of the offset in seconds. This is equivalent to a comparison by ID.

Parameters

obj:Object: the object to check, null returns false

Returns:boolean

true if this is equal to the other offset

Annotations

@Override

from back to summary

from	back to summary
public static ZoneOffset from(TemporalAccessor temporal) Hides java.time.ZoneId.from. Obtains an instance of `ZoneOffset` from a temporal object. This obtains an offset based on the specified temporal. A `TemporalAccessor` represents an arbitrary set of date and time information, which this factory converts to an instance of `ZoneOffset`. A `TemporalAccessor` represents some form of date and time information. This factory converts the arbitrary temporal object to an instance of `ZoneOffset`. The conversion uses the `TemporalQueries#offset()` query, which relies on extracting the `OFFSET_SECONDS` field. This method matches the signature of the functional interface `TemporalQuery` allowing it to be used as a query via method reference, `ZoneOffset::from`. Parameters temporal:TemporalAccessor the temporal object to convert, not null Returns:ZoneOffset the zone-offset, not null Exceptions DateTimeException: if unable to convert to an `ZoneOffset`

public static ZoneOffset from(TemporalAccessor temporal)

Hides java.time.ZoneId.from.

Obtains an instance of ZoneOffset from a temporal object.

This obtains an offset based on the specified temporal. A TemporalAccessor represents an arbitrary set of date and time information, which this factory converts to an instance of ZoneOffset.

A TemporalAccessor represents some form of date and time information. This factory converts the arbitrary temporal object to an instance of ZoneOffset.

The conversion uses the TemporalQueries#offset() query, which relies on extracting the OFFSET_SECONDS field.

This method matches the signature of the functional interface TemporalQuery allowing it to be used as a query via method reference, ZoneOffset::from.

Parameters

temporal:TemporalAccessor: the temporal object to convert, not null

Returns:ZoneOffset

the zone-offset, not null

Exceptions

DateTimeException:: if unable to convert to an ZoneOffset

get back to summary

get	back to summary
public int get(TemporalField field) Overrides default java.time.temporal.TemporalAccessor.get. Gets the value of the specified field from this offset as an `int`. 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. If the field is a `ChronoField` then the query is implemented here. The `OFFSET_SECONDS` field returns the value of the offset. All other `ChronoField` instances will throw an `UnsupportedTemporalTypeException`. If the field is not a `ChronoField`, then the result of this method is obtained by invoking `TemporalField.getFrom(TemporalAccessor)` passing `this` as the argument. Whether the value can be obtained, and what the value represents, is determined by the field. Parameters field:TemporalField the field to get, not null Returns:int the value for the field Annotations @Override Exceptions DateTimeException: if a value for the field cannot be obtained or the value is outside the range of valid values for the field UnsupportedTemporalTypeException: if the field is not supported or the range of values exceeds an `int` ArithmeticException: if numeric overflow occurs

public int get(TemporalField field)

Overrides default java.time.temporal.TemporalAccessor.get.

Gets the value of the specified field from this offset as an int.

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.

If the field is a ChronoField then the query is implemented here. The OFFSET_SECONDS field returns the value of the offset. All other ChronoField instances will throw an UnsupportedTemporalTypeException.

If the field is not a ChronoField, then the result of this method is obtained by invoking TemporalField.getFrom(TemporalAccessor) passing this as the argument. Whether the value can be obtained, and what the value represents, is determined by the field.

Parameters

field:TemporalField: the field to get, not null

Returns:int

the value for the field

Annotations

@Override

Exceptions

DateTimeException:: if a value for the field cannot be obtained or the value is outside the range of valid values for the field
UnsupportedTemporalTypeException:: if the field is not supported or the range of values exceeds an int
ArithmeticException:: if numeric overflow occurs

getId back to summary

getId	back to summary
public String getId() Implements abstract java.time.ZoneId.getId. Gets the normalized zone offset ID. The ID is minor variation to the standard ISO-8601 formatted string for the offset. There are three formats: `Z` - for UTC (ISO-8601) `+hh:mm` or `-hh:mm` - if the seconds are zero (ISO-8601) `+hh:mm:ss` or `-hh:mm:ss` - if the seconds are non-zero (not ISO-8601) Returns:String the zone offset ID, not null Annotations @Override

public String getId()

Implements abstract java.time.ZoneId.getId.

Gets the normalized zone offset ID.

The ID is minor variation to the standard ISO-8601 formatted string for the offset. There are three formats:

Z - for UTC (ISO-8601)
+hh:mm or -hh:mm - if the seconds are zero (ISO-8601)
+hh:mm:ss or -hh:mm:ss - if the seconds are non-zero (not ISO-8601)

Returns:String

the zone offset ID, not null

Annotations

@Override

getLong back to summary

getLong	back to summary
public long getLong(TemporalField field) Implements java.time.temporal.TemporalAccessor.getLong. Gets the value of the specified field from this offset as a `long`. 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. If the field is a `ChronoField` then the query is implemented here. The `OFFSET_SECONDS` field returns the value of the offset. All other `ChronoField` instances will throw an `UnsupportedTemporalTypeException`. If the field is not a `ChronoField`, then the result of this method is obtained by invoking `TemporalField.getFrom(TemporalAccessor)` passing `this` as the argument. Whether the value can be obtained, and what the value represents, is determined by the field. Parameters field:TemporalField the field to get, not null Returns:long the value for the field Annotations @Override Exceptions DateTimeException: if a value for the field cannot be obtained UnsupportedTemporalTypeException: if the field is not supported ArithmeticException: if numeric overflow occurs

public long getLong(TemporalField field)

Implements java.time.temporal.TemporalAccessor.getLong.

Gets the value of the specified field from this offset as a long.

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.

Parameters

field:TemporalField: the field to get, not null

Returns:long

the value for the field

Annotations

@Override

Exceptions

DateTimeException:: if a value for the field cannot be obtained
UnsupportedTemporalTypeException:: if the field is not supported
ArithmeticException:: if numeric overflow occurs

getOffset	back to summary
pack-priv ZoneOffset getOffset(long epochSecond) Implements abstract java.time.ZoneId.getOffset. Doc from java.time.ZoneId.getOffset. Get the effective offset for an instant at the given epochSecond. Annotations @Override

getOffset

back to summary

pack-priv ZoneOffset getOffset(long epochSecond)

Implements abstract java.time.ZoneId.getOffset.

Doc from java.time.ZoneId.getOffset.

Get the effective offset for an instant at the given epochSecond.

Annotations

@Override

getRules	back to summary
public ZoneRules getRules() Implements abstract java.time.ZoneId.getRules. Gets the associated time-zone rules. The rules will always return this offset when queried. The implementation class is immutable, thread-safe and serializable. Returns:ZoneRules the rules, not null Annotations @Override

getRules

back to summary

public ZoneRules getRules()

Implements abstract java.time.ZoneId.getRules.

Gets the associated time-zone rules.

The rules will always return this offset when queried. The implementation class is immutable, thread-safe and serializable.

Returns:ZoneRules

the rules, not null

Annotations

@Override

getTotalSeconds	back to summary
public int getTotalSeconds() Gets the total zone offset in seconds. 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. Returns:int the total zone offset amount in seconds

getTotalSeconds

back to summary

public int getTotalSeconds()

Gets the total zone offset in seconds.

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.

Returns:int: the total zone offset amount in seconds

hashCode	back to summary
public int hashCode() Overrides java.time.ZoneId.hashCode. A hash code for this offset. Returns:int a suitable hash code Annotations @Override

hashCode

back to summary

public int hashCode()

Overrides java.time.ZoneId.hashCode.

A hash code for this offset.

Returns:int

a suitable hash code

Annotations

@Override

isSupported back to summary

isSupported	back to summary
public boolean isSupported(TemporalField field) Implements java.time.temporal.TemporalAccessor.isSupported. Checks if the specified field is supported. This checks if this offset can be queried for the specified field. If false, then calling the `range` and `get` methods will throw an exception. If the field is a `ChronoField` then the query is implemented here. The `OFFSET_SECONDS` field returns true. All other `ChronoField` instances will return false. If the field is not a `ChronoField`, then the result of this method is obtained by invoking `TemporalField.isSupportedBy(TemporalAccessor)` passing `this` as the argument. Whether the field is supported is determined by the field. Parameters field:TemporalField the field to check, null returns false Returns:boolean true if the field is supported on this offset, false if not Annotations @Override

public boolean isSupported(TemporalField field)

Implements java.time.temporal.TemporalAccessor.isSupported.

Checks if the specified field is supported.

This checks if this offset can be queried for the specified field. If false, then calling the range and get methods will throw an exception.

If the field is a ChronoField then the query is implemented here. The OFFSET_SECONDS field returns true. All other ChronoField instances will return false.

If the field is not a ChronoField, then the result of this method is obtained by invoking TemporalField.isSupportedBy(TemporalAccessor) passing this as the argument. Whether the field is supported is determined by the field.

Parameters

field:TemporalField: the field to check, null returns false

Returns:boolean

true if the field is supported on this offset, false if not

Annotations

@Override

normalized back to summary

normalized	back to summary
public ZoneId normalized() Overrides java.time.ZoneId.normalized. Doc from java.time.ZoneId.normalized. Normalizes the time-zone ID, returning a `ZoneOffset` where possible. The returns a normalized `ZoneId` that can be used in place of this ID. The result will have `ZoneRules` equivalent to those returned by this object, however the ID returned by `getId()` may be different. The normalization checks if the rules of this `ZoneId` have a fixed offset. If they do, then the `ZoneOffset` equal to that offset is returned. Otherwise `this` is returned. Annotations @Override

public ZoneId normalized()

Overrides java.time.ZoneId.normalized.

Doc from java.time.ZoneId.normalized.

Normalizes the time-zone ID, returning a ZoneOffset where possible.

The returns a normalized ZoneId that can be used in place of this ID. The result will have ZoneRules equivalent to those returned by this object, however the ID returned by getId() may be different.

The normalization checks if the rules of this ZoneId have a fixed offset. If they do, then the ZoneOffset equal to that offset is returned. Otherwise this is returned.

Annotations

@Override

of back to summary

of	back to summary
public static ZoneOffset of(String offsetId) Hides java.time.ZoneId.of. Obtains an instance of `ZoneOffset` using the ID. This method parses the string ID of a `ZoneOffset` to return an instance. The parsing accepts all the formats generated by `getId()`, plus some additional formats: `Z` - for UTC `+h` `+hh` `+hh:mm` `-hh:mm` `+hhmm` `-hhmm` `+hh:mm:ss` `-hh:mm:ss` `+hhmmss` `-hhmmss` Note that ± means either the plus or minus symbol. The ID of the returned offset will be normalized to one of the formats described by `getId()`. The maximum supported range is from +18:00 to -18:00 inclusive. Parameters offsetId:String the offset ID, not null Returns:ZoneOffset the zone-offset, not null Annotations @SuppressWarnings:fallthrough Exceptions DateTimeException: if the offset ID is invalid

public static ZoneOffset of(String offsetId)

Hides java.time.ZoneId.of.

Obtains an instance of ZoneOffset using the ID.

This method parses the string ID of a ZoneOffset to return an instance. The parsing accepts all the formats generated by getId(), plus some additional formats:

Z - for UTC
+h
+hh
+hh:mm
-hh:mm
+hhmm
-hhmm
+hh:mm:ss
-hh:mm:ss
+hhmmss
-hhmmss

Note that ± means either the plus or minus symbol.

The ID of the returned offset will be normalized to one of the formats described by getId().

The maximum supported range is from +18:00 to -18:00 inclusive.

Parameters

offsetId:String: the offset ID, not null

Returns:ZoneOffset

the zone-offset, not null

Annotations

@SuppressWarnings:fallthrough

Exceptions

DateTimeException:: if the offset ID is invalid

ofHours back to summary

ofHours	back to summary
public static ZoneOffset ofHours(int hours) Obtains an instance of `ZoneOffset` using an offset in hours. Parameters hours:int the time-zone offset in hours, from -18 to +18 Returns:ZoneOffset the zone-offset, not null Exceptions DateTimeException: if the offset is not in the required range

public static ZoneOffset ofHours(int hours)

Obtains an instance of ZoneOffset using an offset in hours.

Parameters

hours:int: the time-zone offset in hours, from -18 to +18

Returns:ZoneOffset

the zone-offset, not null

Exceptions

DateTimeException:: if the offset is not in the required range

ofHoursMinutes back to summary

ofHoursMinutes	back to summary
public static ZoneOffset ofHoursMinutes(int hours, int minutes) Obtains an instance of `ZoneOffset` using an offset in hours and minutes. The sign of the hours and minutes components must match. Thus, if the hours is negative, the minutes must be negative or zero. If the hours is zero, the minutes may be positive, negative or zero. Parameters hours:int the time-zone offset in hours, from -18 to +18 minutes:int the time-zone offset in minutes, from 0 to ±59, sign matches hours Returns:ZoneOffset the zone-offset, not null Exceptions DateTimeException: if the offset is not in the required range

public static ZoneOffset ofHoursMinutes(int hours, int minutes)

Obtains an instance of ZoneOffset using an offset in hours and minutes.

The sign of the hours and minutes components must match. Thus, if the hours is negative, the minutes must be negative or zero. If the hours is zero, the minutes may be positive, negative or zero.

Parameters

hours:int: the time-zone offset in hours, from -18 to +18
minutes:int: the time-zone offset in minutes, from 0 to ±59, sign matches hours

Returns:ZoneOffset

the zone-offset, not null

Exceptions

DateTimeException:: if the offset is not in the required range

ofHoursMinutesSeconds back to summary

ofHoursMinutesSeconds	back to summary
public static ZoneOffset ofHoursMinutesSeconds(int hours, int minutes, int seconds) Obtains an instance of `ZoneOffset` using an offset in hours, minutes and seconds. The sign of the hours, minutes and seconds components must match. Thus, if the hours is negative, the minutes and seconds must be negative or zero. Parameters hours:int the time-zone offset in hours, from -18 to +18 minutes:int the time-zone offset in minutes, from 0 to ±59, sign matches hours and seconds seconds:int the time-zone offset in seconds, from 0 to ±59, sign matches hours and minutes Returns:ZoneOffset the zone-offset, not null Exceptions DateTimeException: if the offset is not in the required range

public static ZoneOffset ofHoursMinutesSeconds(int hours, int minutes, int seconds)

Obtains an instance of ZoneOffset using an offset in hours, minutes and seconds.

The sign of the hours, minutes and seconds components must match. Thus, if the hours is negative, the minutes and seconds must be negative or zero.

Parameters

hours:int: the time-zone offset in hours, from -18 to +18
minutes:int: the time-zone offset in minutes, from 0 to ±59, sign matches hours and seconds
seconds:int: the time-zone offset in seconds, from 0 to ±59, sign matches hours and minutes

Returns:ZoneOffset

the zone-offset, not null

Exceptions

DateTimeException:: if the offset is not in the required range

ofTotalSeconds back to summary

ofTotalSeconds	back to summary
public static ZoneOffset ofTotalSeconds(int totalSeconds) Obtains an instance of `ZoneOffset` specifying the total offset in seconds The offset must be in the range `-18:00` to `+18:00`, which corresponds to -64,800 to +64,800. Parameters totalSeconds:int the total time-zone offset in seconds, from -64,800 to +64,800 Returns:ZoneOffset the ZoneOffset, not null Exceptions DateTimeException: if the offset is not in the required range

public static ZoneOffset ofTotalSeconds(int totalSeconds)

Obtains an instance of ZoneOffset specifying the total offset in seconds

The offset must be in the range -18:00 to +18:00, which corresponds to -64,800 to +64,800.

Parameters

totalSeconds:int: the total time-zone offset in seconds, from -64,800 to +64,800

Returns:ZoneOffset

the ZoneOffset, not null

Exceptions

DateTimeException:: if the offset is not in the required range

parseNumber	back to summary
private static int parseNumber(CharSequence offsetId, int pos, boolean precededByColon) Parse a two digit zero-prefixed number. Parameters offsetId:CharSequence the offset ID, not null pos:int the position to parse, valid precededByColon:boolean should this number be prefixed by a precededByColon Returns:int the parsed number, from 0 to 99

parseNumber

back to summary

private static int parseNumber(CharSequence offsetId, int pos, boolean precededByColon)

Parse a two digit zero-prefixed number.

Parameters

offsetId:CharSequence: the offset ID, not null
pos:int: the position to parse, valid
precededByColon:boolean: should this number be prefixed by a precededByColon

Returns:int

the parsed number, from 0 to 99

query back to summary

query	back to summary
public <R> R query(TemporalQuery<R> query) Overrides default java.time.temporal.TemporalAccessor.query. Queries this offset using the specified query. This queries this offset using the specified query strategy object. The `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. The result of this method is obtained by invoking the `TemporalQuery#queryFrom(TemporalAccessor)` method on the specified query passing `this` as the argument. Parameters <R> the type of the result query:TemporalQuery<R> the query to invoke, not null Returns:R the query result, null may be returned (defined by the query) Annotations @SuppressWarnings:unchecked @Override Exceptions DateTimeException: if unable to query (defined by the query) ArithmeticException: if numeric overflow occurs (defined by the query)

public <R> R query(TemporalQuery<R> query)

Overrides default java.time.temporal.TemporalAccessor.query.

Queries this offset using the specified query.

This queries this offset using the specified query strategy object. The 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.

The result of this method is obtained by invoking the TemporalQuery#queryFrom(TemporalAccessor) method on the specified query passing this as the argument.

Parameters

<R>: the type of the result
query:TemporalQuery<R>: the query to invoke, not null

Returns:R

the query result, null may be returned (defined by the query)

Annotations

@SuppressWarnings:unchecked
@Override

Exceptions

DateTimeException:: if unable to query (defined by the query)
ArithmeticException:: if numeric overflow occurs (defined by the query)

range back to summary

range	back to summary
public ValueRange range(TemporalField field) Overrides default java.time.temporal.TemporalAccessor.range. Gets the range of valid values for the specified field. 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. If the field is a `ChronoField` then the query is implemented here. The `supported fields` will return appropriate range instances. All other `ChronoField` instances will throw an `UnsupportedTemporalTypeException`. If the field is not a `ChronoField`, then the result of this method is obtained by invoking `TemporalField.rangeRefinedBy(TemporalAccessor)` passing `this` as the argument. Whether the range can be obtained is determined by the field. Parameters field:TemporalField the field to query the range for, not null Returns:ValueRange the range of valid values for the field, not null Annotations @Override Exceptions DateTimeException: if the range for the field cannot be obtained UnsupportedTemporalTypeException: if the field is not supported

public ValueRange range(TemporalField field)

Overrides default java.time.temporal.TemporalAccessor.range.

Gets the range of valid values for the specified field.

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.

If the field is a ChronoField then the query is implemented here. The supported fields will return appropriate range instances. All other ChronoField instances will throw an UnsupportedTemporalTypeException.

If the field is not a ChronoField, then the result of this method is obtained by invoking TemporalField.rangeRefinedBy(TemporalAccessor) passing this as the argument. Whether the range can be obtained is determined by the field.

Parameters

field:TemporalField: the field to query the range for, not null

Returns:ValueRange

the range of valid values for the field, not null

Annotations

@Override

Exceptions

DateTimeException:: if the range for the field cannot be obtained
UnsupportedTemporalTypeException:: if the field is not supported

readExternal	back to summary
pack-priv static ZoneOffset readExternal(DataInput in) throws IOException

readObject	back to summary
private void readObject(ObjectInputStream s) throws InvalidObjectException Hides java.time.ZoneId.readObject. Defend against malicious streams. Parameters s:ObjectInputStream the stream to read Annotations @Serial Exceptions InvalidObjectException: always

readObject

back to summary

private void readObject(ObjectInputStream s) throws InvalidObjectException

Hides java.time.ZoneId.readObject.

Defend against malicious streams.

Parameters

s:ObjectInputStream: the stream to read

Annotations

@Serial

Exceptions

InvalidObjectException:: always

toString back to summary

toString	back to summary
public String toString() Overrides java.time.ZoneId.toString. Outputs this offset as a `String`, using the normalized ID. Returns:String a string representation of this offset, not null Annotations @Override

public String toString()

Overrides java.time.ZoneId.toString.

Outputs this offset as a String, using the normalized ID.

Returns:String

a string representation of this offset, not null

Annotations

@Override

totalSeconds	back to summary
private static int totalSeconds(int hours, int minutes, int seconds) Calculates the total offset in seconds. Parameters hours:int the time-zone offset in hours, from -18 to +18 minutes:int the time-zone offset in minutes, from 0 to ±59, sign matches hours and seconds seconds:int the time-zone offset in seconds, from 0 to ±59, sign matches hours and minutes Returns:int the total in seconds

totalSeconds

back to summary

private static int totalSeconds(int hours, int minutes, int seconds)

Calculates the total offset in seconds.

Parameters

hours:int: the time-zone offset in hours, from -18 to +18
minutes:int: the time-zone offset in minutes, from 0 to ±59, sign matches hours and seconds
seconds:int: the time-zone offset in seconds, from 0 to ±59, sign matches hours and minutes

Returns:int

the total in seconds

validate	back to summary
private static void validate(int hours, int minutes, int seconds) Validates the offset fields. Parameters hours:int the time-zone offset in hours, from -18 to +18 minutes:int the time-zone offset in minutes, from 0 to ±59 seconds:int the time-zone offset in seconds, from 0 to ±59 Exceptions DateTimeException: if the offset is not in the required range

validate

back to summary

private static void validate(int hours, int minutes, int seconds)

Validates the offset fields.

Parameters

hours:int: the time-zone offset in hours, from -18 to +18
minutes:int: the time-zone offset in minutes, from 0 to ±59
seconds:int: the time-zone offset in seconds, from 0 to ±59

Exceptions

DateTimeException:: if the offset is not in the required range

write	back to summary
pack-priv void write(DataOutput out) throws IOException Implements abstract java.time.ZoneId.write. Annotations @Override

write

back to summary

pack-priv void write(DataOutput out) throws IOException

Implements abstract java.time.ZoneId.write.

Annotations

@Override

writeExternal	back to summary
pack-priv void writeExternal(DataOutput out) throws IOException

writeReplace back to summary

writeReplace	back to summary
private Object writeReplace() Hides java.time.ZoneId.writeReplace. Writes the object using a dedicated serialized form. Returns:Object the instance of `Ser`, not null Annotations @Serial Serial data out.writeByte(8); // identifies a ZoneOffset int offsetByte = totalSeconds % 900 == 0 ? totalSeconds / 900 : 127; out.writeByte(offsetByte); if (offsetByte == 127) { out.writeInt(totalSeconds); }

private Object writeReplace()

Hides java.time.ZoneId.writeReplace.

Writes the object using a dedicated serialized form.

Returns:Object

the instance of Ser, not null

Annotations

@Serial

Serial data

 out.writeByte(8);                  // identifies a ZoneOffset
 int offsetByte = totalSeconds % 900 == 0 ? totalSeconds / 900 : 127;
 out.writeByte(offsetByte);
 if (offsetByte == 127) {
     out.writeInt(totalSeconds);
 }

public final Class ZoneOffset

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail