- Description
- Field Summary
- Method Summary
- Field Details
- Method Details
- of(String)
- ofHours(int)
- ofHoursMinutes(int, int)
- ofHoursMinutesSeconds(int, int, int)
- from(TemporalAccessor)
- ofTotalSeconds(int)
- getTotalSeconds()
- getId()
- getRules()
- isSupported(TemporalField)
- range(TemporalField)
- get(TemporalField)
- getLong(TemporalField)
- query(TemporalQuery)
- adjustInto(Temporal)
- compareTo(ZoneOffset)
- equals(Object)
- hashCode()
- toString()
Class ZoneOffset
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.
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 ZoneId class.
For example, Paris is one hour ahead of Greenwich/UTC in winter and two hours ahead in summer. The ZoneId instance for Paris will reference two ZoneOffset instances - a +01:00 instance for winter, and a +02:00 instance for summer.
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.
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.
Instances of ZoneOffset must be compared using equals(Object). Implementations may choose to cache certain common offsets, however applications must not rely on such caching.
This is a value-based class; programmers should treat instances that are equal as interchangeable and should not use instances for synchronization, or unpredictable behavior may occur. For example, in a future release, synchronization may fail. The equals method should be used for comparisons.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final ZoneOffsetConstant for the maximum supported offset.static final ZoneOffsetConstant for the minimum supported offset.static final ZoneOffsetThe time-zone offset for UTC, with an ID of 'Z'. -
Method Summary
All MethodsStatic MethodsInstance MethodsConcrete MethodsModifier and TypeMethodDescriptionadjustInto(Temporal temporal)Adjusts the specified temporal object to have the same offset as this object.intcompareTo(ZoneOffset other)Compares this offset to another offset in descending order.booleanChecks if this offset is equal to another offset.static ZoneOffsetfrom(TemporalAccessor temporal)Obtains an instance of ZoneOffset from a temporal object.intget(TemporalField field)Gets the value of the specified field from this offset as an int.getId()Gets the normalized zone offset ID.longgetLong(TemporalField field)Gets the value of the specified field from this offset as a long.getRules()Gets the associated time-zone rules.intGets the total zone offset in seconds.inthashCode()A hash code for this offset.booleanisSupported(TemporalField field)Checks if the specified field is supported.static ZoneOffsetObtains an instance of ZoneOffset using the ID.static ZoneOffsetofHours(int hours)Obtains an instance of ZoneOffset using an offset in hours.static ZoneOffsetofHoursMinutes(int hours, int minutes)Obtains an instance of ZoneOffset using an offset in hours and minutes.static ZoneOffsetofHoursMinutesSeconds(int hours, int minutes, int seconds)Obtains an instance of ZoneOffset using an offset in hours, minutes and seconds.static ZoneOffsetofTotalSeconds(int totalSeconds)Obtains an instance of ZoneOffset specifying the total offset in seconds<R> Rquery(TemporalQuery<R> query)Queries this offset using the specified query.range(TemporalField field)Gets the range of valid values for the specified field.toString()Outputs this offset as a String, using the normalized ID.Methods declared in class ZoneId
getAvailableZoneIds, getDisplayName, normalized, of, ofOffset, systemDefaultModifier and TypeMethodDescriptionGets the set of available zone IDs.Gets the textual representation of the zone, such as 'British Time' or '+02:00'.Normalizes the time-zone ID, returning a ZoneOffset where possible.static ZoneIdObtains an instance of ZoneId using its ID using a map of aliases to supplement the standard zone IDs.static ZoneIdObtains an instance of ZoneId wrapping an offset.static ZoneIdGets the system default time-zone.Methods declared in class Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitModifier and TypeMethodDescriptionprotected Objectclone()Creates and returns a copy of this object.protected voidfinalize()Deprecated, for removal: This API element is subject to removal in a future version.Finalization is deprecated and subject to removal in a future release.final Class<?>getClass()Returns the runtime class of this Object.final voidnotify()Wakes up a single thread that is waiting on this object's monitor.final voidWakes up all threads that are waiting on this object's monitor.final voidwait()Causes the current thread to wait until it is awakened, typically by being notified or interrupted.final voidwait(long timeoutMillis)Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.final voidwait(long timeoutMillis, int nanos)Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
-
Field Details
-
UTC
The time-zone offset for UTC, with an ID of 'Z'. -
MIN
Constant for the minimum supported offset. -
MAX
Constant for the maximum supported offset.
-
-
Method Details
-
of
Obtains an instance of ZoneOffset using the ID.Parameters: offsetId - the offset ID, not null Returns: the zone-offset, not null Throws: DateTimeException - if the offset ID is invalidThis 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
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.
-
ofHours
Obtains an instance of ZoneOffset using an offset in hours.Parameters: hours - the time-zone offset in hours, from -18 to +18 Returns: the zone-offset, not null Throws: DateTimeException - if the offset is not in the required range -
ofHoursMinutes
Obtains an instance of ZoneOffset using an offset in hours and minutes.Parameters: hours - the time-zone offset in hours, from -18 to +18 minutes - the time-zone offset in minutes, from 0 to ±59, sign matches hours Returns: the zone-offset, not null Throws: DateTimeException - if the offset is not in the required rangeThe 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.
-
ofHoursMinutesSeconds
Obtains an instance of ZoneOffset using an offset in hours, minutes and seconds.Parameters: hours - the time-zone offset in hours, from -18 to +18 minutes - the time-zone offset in minutes, from 0 to ±59, sign matches hours and seconds seconds - the time-zone offset in seconds, from 0 to ±59, sign matches hours and minutes Returns: the zone-offset, not null Throws: DateTimeException - if the offset is not in the required rangeThe 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.
-
from
Obtains an instance of ZoneOffset from a temporal object.Parameters: temporal - the temporal object to convert, not null Returns: the zone-offset, not null Throws: DateTimeException - if unable to convert to an ZoneOffsetThis 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.
-
ofTotalSeconds
Obtains an instance of ZoneOffset specifying the total offset in secondsParameters: totalSeconds - the total time-zone offset in seconds, from -64,800 to +64,800 Returns: the ZoneOffset, not null Throws: DateTimeException - if the offset is not in the required rangeThe offset must be in the range -18:00 to +18:00, which corresponds to -64,800 to +64,800.
-
getTotalSeconds
public int getTotalSeconds()Gets the total zone offset in seconds.Returns: the total zone offset amount in secondsThis 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.
-
getId
Gets the normalized zone offset ID.Specified by: getId in class ZoneId Returns: the zone offset ID, not nullThe 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)
-
getRules
-
isSupported
Checks if the specified field is supported.Specified by: isSupported in interface TemporalAccessor Parameters: field - the field to check, null returns false Returns: true if the field is supported on this offset, false if notThis 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.
-
range
Gets the range of valid values for the specified field.Specified by: range in interface TemporalAccessor Parameters: field - the field to query the range for, not null Returns: the range of valid values for the field, not null Throws: DateTimeException - if the range for the field cannot be obtained UnsupportedTemporalTypeException - if the field is not supportedThe 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.
-
get
Gets the value of the specified field from this offset as an int.Specified by: get in interface TemporalAccessor Parameters: field - the field to get, not null Returns: the value for the field Throws: 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 occursThis 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.
-
getLong
Gets the value of the specified field from this offset as a long.Specified by: getLong in interface TemporalAccessor Parameters: field - the field to get, not null Returns: the value for the field Throws: DateTimeException - if a value for the field cannot be obtained UnsupportedTemporalTypeException - if the field is not supported ArithmeticException - if numeric overflow occursThis 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.
-
query
Queries this offset using the specified query.Specified by: query in interface TemporalAccessor Type Parameters: R - the type of the result Parameters: query - the query to invoke, not null Returns: the query result, null may be returned (defined by the query) Throws: DateTimeException - if unable to query (defined by the query) ArithmeticException - if numeric overflow occurs (defined by the 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.
-
adjustInto
Adjusts the specified temporal object to have the same offset as this object.Specified by: adjustInto in interface TemporalAdjuster Parameters: temporal - the target object to be adjusted, not null Returns: the adjusted object, not null Throws: DateTimeException - if unable to make the adjustment ArithmeticException - if numeric overflow occursThis 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.
-
compareTo
Compares this offset to another offset in descending order.Specified by: compareTo in interface Comparable<ZoneOffset> Parameters: other - the other date to compare to, not null 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 Throws: NullPointerException - if other is nullThe 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.
-
equals
Checks if this offset is equal to another offset.Overrides: equals in class ZoneId Parameters: obj - the object to check, null returns false Returns: true if this is equal to the other offset See Also:The comparison is based on the amount of the offset in seconds. This is equivalent to a comparison by ID.
-
hashCode
-
toString
-
Report a bug or suggest an enhancement
For further API reference and developer documentation see the Java SE Documentation, which contains more detailed, developer-targeted descriptions with conceptual overviews, definitions of terms, workarounds, and working code examples. Other versions.
Java is a trademark or registered trademark of Oracle and/or its affiliates in the US and other countries.
Copyright © 1993, 2026, Oracle and/or its affiliates, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.
All rights reserved. Use is subject to license terms and the documentation redistribution policy.