Class ZoneOffset
- All Implemented Interfaces:
Serializable
,Comparable<ZoneOffset>
,TemporalAccessor
,TemporalAdjuster
+02:00
.
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(java.lang.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.
- Implementation Requirements:
- This class is immutable and thread-safe.
- Since:
- 1.8
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionstatic final ZoneOffset
Constant for the maximum supported offset.static final ZoneOffset
Constant for the minimum supported offset.static final ZoneOffset
The time-zone offset for UTC, with an ID of 'Z'. -
Method Summary
Modifier and TypeMethodDescriptionadjustInto
(Temporal temporal) Adjusts the specified temporal object to have the same offset as this object.int
compareTo
(ZoneOffset other) Compares this offset to another offset in descending order.boolean
Checks if this offset is equal to another offset.static ZoneOffset
from
(TemporalAccessor temporal) Obtains an instance ofZoneOffset
from a temporal object.int
get
(TemporalField field) Gets the value of the specified field from this offset as anint
.getId()
Gets the normalized zone offset ID.long
getLong
(TemporalField field) Gets the value of the specified field from this offset as along
.getRules()
Gets the associated time-zone rules.int
Gets the total zone offset in seconds.int
hashCode()
A hash code for this offset.boolean
isSupported
(TemporalField field) Checks if the specified field is supported.Normalizes the time-zone ID, returning aZoneOffset
where possible.static ZoneOffset
Obtains an instance ofZoneOffset
using the ID.static ZoneOffset
ofHours
(int hours) Obtains an instance ofZoneOffset
using an offset in hours.static ZoneOffset
ofHoursMinutes
(int hours, int minutes) Obtains an instance ofZoneOffset
using an offset in hours and minutes.static ZoneOffset
ofHoursMinutesSeconds
(int hours, int minutes, int seconds) Obtains an instance ofZoneOffset
using an offset in hours, minutes and seconds.static ZoneOffset
ofTotalSeconds
(int totalSeconds) Obtains an instance ofZoneOffset
specifying the total offset in seconds<R> R
query
(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 aString
, using the normalized ID.Methods inherited from class java.time.ZoneId
getAvailableZoneIds, getDisplayName, of, ofOffset, systemDefault
-
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 ofZoneOffset
using the ID.This method parses the string ID of a
ZoneOffset
to return an instance. The parsing accepts all the formats generated bygetId()
, 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.
- Parameters:
offsetId
- the offset ID, not null- Returns:
- the zone-offset, not null
- Throws:
DateTimeException
- if the offset ID is invalid
-
ofHours
Obtains an instance ofZoneOffset
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 ofZoneOffset
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
- the time-zone offset in hours, from -18 to +18minutes
- 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 range
-
ofHoursMinutesSeconds
Obtains an instance ofZoneOffset
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
- the time-zone offset in hours, from -18 to +18minutes
- the time-zone offset in minutes, from 0 to ±59, sign matches hours and secondsseconds
- 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 range
-
from
Obtains an instance ofZoneOffset
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 ofZoneOffset
.A
TemporalAccessor
represents some form of date and time information. This factory converts the arbitrary temporal object to an instance ofZoneOffset
.The conversion uses the
TemporalQueries.offset()
query, which relies on extracting theOFFSET_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
- the temporal object to convert, not null- Returns:
- the zone-offset, not null
- Throws:
DateTimeException
- if unable to convert to anZoneOffset
-
ofTotalSeconds
Obtains an instance ofZoneOffset
specifying the total offset in secondsThe offset must be in the range
-18:00
to+18:00
, which corresponds to -64800 to +64800.- Parameters:
totalSeconds
- the total time-zone offset in seconds, from -64800 to +64800- Returns:
- the ZoneOffset, not null
- Throws:
DateTimeException
- if the offset is not in the required range
-
getTotalSeconds
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:
- the total zone offset amount in seconds
-
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)
-
getRules
-
normalized
Description copied from class:ZoneId
Normalizes the time-zone ID, returning aZoneOffset
where possible.The returns a normalized
ZoneId
that can be used in place of this ID. The result will haveZoneRules
equivalent to those returned by this object, however the ID returned bygetId()
may be different.The normalization checks if the rules of this
ZoneId
have a fixed offset. If they do, then theZoneOffset
equal to that offset is returned. Otherwisethis
is returned.- Overrides:
normalized
in classZoneId
- Returns:
- the time-zone unique ID, not null
-
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
andget
methods will throw an exception.If the field is a
ChronoField
then the query is implemented here. TheOFFSET_SECONDS
field returns true. All otherChronoField
instances will return false.If the field is not a
ChronoField
, then the result of this method is obtained by invokingTemporalField.isSupportedBy(TemporalAccessor)
passingthis
as the argument. Whether the field is supported is determined by the field.- Specified by:
isSupported
in interfaceTemporalAccessor
- Parameters:
field
- the field to check, null returns false- Returns:
- true if the field is supported on this offset, false if not
-
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. Thesupported fields
will return appropriate range instances. All otherChronoField
instances will throw anUnsupportedTemporalTypeException
.If the field is not a
ChronoField
, then the result of this method is obtained by invokingTemporalField.rangeRefinedBy(TemporalAccessor)
passingthis
as the argument. Whether the range can be obtained is determined by the field.- Specified by:
range
in interfaceTemporalAccessor
- 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 obtainedUnsupportedTemporalTypeException
- if the field is not supported
-
get
Gets the value of the specified field from this offset as anint
.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. TheOFFSET_SECONDS
field returns the value of the offset. All otherChronoField
instances will throw anUnsupportedTemporalTypeException
.If the field is not a
ChronoField
, then the result of this method is obtained by invokingTemporalField.getFrom(TemporalAccessor)
passingthis
as the argument. Whether the value can be obtained, and what the value represents, is determined by the field.- Specified by:
get
in interfaceTemporalAccessor
- 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 fieldUnsupportedTemporalTypeException
- if the field is not supported or the range of values exceeds anint
ArithmeticException
- if numeric overflow occurs
-
getLong
Gets the value of the specified field from this offset as along
.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. TheOFFSET_SECONDS
field returns the value of the offset. All otherChronoField
instances will throw anUnsupportedTemporalTypeException
.If the field is not a
ChronoField
, then the result of this method is obtained by invokingTemporalField.getFrom(TemporalAccessor)
passingthis
as the argument. Whether the value can be obtained, and what the value represents, is determined by the field.- Specified by:
getLong
in interfaceTemporalAccessor
- Parameters:
field
- the field to get, not null- Returns:
- the value for the field
- Throws:
DateTimeException
- if a value for the field cannot be obtainedUnsupportedTemporalTypeException
- if the field is not supportedArithmeticException
- if numeric overflow occurs
-
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 passingthis
as the argument.- Specified by:
query
in interfaceTemporalAccessor
- 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)
-
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)
passingChronoField.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.
- Specified by:
adjustInto
in interfaceTemporalAdjuster
- Parameters:
temporal
- the target object to be adjusted, not null- Returns:
- the adjusted object, not null
- Throws:
DateTimeException
- if unable to make the adjustmentArithmeticException
- if numeric overflow occurs
-
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
.- Specified by:
compareTo
in interfaceComparable<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 thanother
totalSeconds - Throws:
NullPointerException
- ifother
is null
-
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.
-
hashCode
-
toString
-