org.threeten.bp

ZoneOffset

final class ZoneOffset extends ZoneId with TemporalAccessor with TemporalAdjuster with Ordered[ZoneOffset] with Serializable

A time-zone offset from Greenwich/UTC, such as +02:00.

A time-zone offset is the period 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. Implementations may choose to cache certain common offsets, however applications must not rely on such caching.

Specification for implementors

This class is immutable and thread-safe.

Annotations
@SerialVersionUID( 2357656521762053153L )
Linear Supertypes
Ordered[ZoneOffset], Comparable[ZoneOffset], TemporalAdjuster, TemporalAccessor, ZoneId, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. ZoneOffset
  2. Ordered
  3. Comparable
  4. TemporalAdjuster
  5. TemporalAccessor
  6. ZoneId
  7. Serializable
  8. AnyRef
  9. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. def <(that: ZoneOffset): Boolean

    Definition Classes
    Ordered
  5. def <=(that: ZoneOffset): Boolean

    Definition Classes
    Ordered
  6. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  7. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  8. def >(that: ZoneOffset): Boolean

    Definition Classes
    Ordered
  9. def >=(that: ZoneOffset): Boolean

    Definition Classes
    Ordered
  10. def adjustInto(temporal: Temporal): Temporal

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

    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.

    temporal

    the target object to be adjusted, not null

    returns

    the adjusted object, not null

    Definition Classes
    ZoneOffsetTemporalAdjuster
    Exceptions thrown
    ArithmeticException

    if numeric overflow occurs

    DateTimeException

    if unable to make the adjustment

  11. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  12. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  13. def compare(other: ZoneOffset): Int

    Compares this offset to another offset in descending order.

    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.

    other

    the other date to compare to, not null

    returns

    the comparator value, negative if less, postive if greater

    Definition Classes
    ZoneOffset → Ordered
    Exceptions thrown
    NullPointerException

    if { @code other} is null

  14. def compareTo(that: ZoneOffset): Int

    Definition Classes
    Ordered → Comparable
  15. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  16. def equals(obj: Any): Boolean

    Checks if this offset is equal to another offset.

    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.

    obj

    the object to check, null returns false

    returns

    true if this is equal to the other offset

    Definition Classes
    ZoneOffsetZoneId → AnyRef → Any
  17. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  18. def get(field: TemporalField): Int

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

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

    This queries this offset for the value for 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 a DateTimeException.

    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.

    field

    the field to get, not null

    returns

    the value for the field

    Definition Classes
    ZoneOffsetTemporalAccessor
    Exceptions thrown
    ArithmeticException

    if numeric overflow occurs

    DateTimeException

    if a value for the field cannot be obtained

  19. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  20. def getDisplayName(style: TextStyle, locale: Locale): String

    Gets the textual representation of the zone, such as 'British Time' or '+02:00'.

    Gets the textual representation of the zone, such as 'British Time' or '+02:00'.

    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.

    If no textual mapping is found then the #getId() full ID is returned.

    style

    the length of the text required, not null

    locale

    the locale to use, not null

    returns

    the text value of the zone, not null

    Definition Classes
    ZoneId
  21. def getId: String

    Gets the normalized zone offset ID.

    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

    the zone offset ID, not null

    Definition Classes
    ZoneOffsetZoneId
  22. def getLong(field: TemporalField): Long

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

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

    This queries this offset for the value for 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 a DateTimeException.

    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.

    field

    the field to get, not null

    returns

    the value for the field

    Definition Classes
    ZoneOffsetTemporalAccessor
    Exceptions thrown
    ArithmeticException

    if numeric overflow occurs

    DateTimeException

    if a value for the field cannot be obtained

  23. def getRules: ZoneRules

    Gets the associated time-zone rules.

    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

    the rules, not null

    Definition Classes
    ZoneOffsetZoneId
  24. def getTotalSeconds: Int

    Gets the total zone offset in seconds.

    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

  25. def hashCode(): Int

    A hash code for this offset.

    A hash code for this offset.

    returns

    a suitable hash code

    Definition Classes
    ZoneOffsetZoneId → AnyRef → Any
  26. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  27. def isSupported(field: TemporalField): Boolean

    Checks if the specified field is supported.

    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(TemporalField) range and #get(TemporalField) 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.

    field

    the field to check, null returns false

    returns

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

    Definition Classes
    ZoneOffsetTemporalAccessor
  28. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  29. def normalized: ZoneId

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

    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.

    returns

    the time-zone unique ID, not null

    Definition Classes
    ZoneId
  30. final def notify(): Unit

    Definition Classes
    AnyRef
  31. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  32. def query[R >: Null](query: TemporalQuery[R]): R

    Queries this offset using the specified 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.

    R

    the type of the result

    query

    the query to invoke, not null

    returns

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

    Definition Classes
    ZoneOffsetTemporalAccessor
    Exceptions thrown
    ArithmeticException

    if numeric overflow occurs (defined by the query)

    DateTimeException

    if unable to query (defined by the query)

  33. def range(field: TemporalField): ValueRange

    Gets the range of valid values for the specified field.

    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 #isSupported(TemporalField) supported fields will return appropriate range instances. All other ChronoField instances will throw a DateTimeException.

    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.

    field

    the field to query the range for, not null

    returns

    the range of valid values for the field, not null

    Definition Classes
    ZoneOffsetTemporalAccessor
    Exceptions thrown
    DateTimeException

    if the range for the field cannot be obtained

  34. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  35. def toString(): String

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

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

    returns

    a string representation of this offset, not null

    Definition Classes
    ZoneOffsetZoneId → AnyRef → Any
  36. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  37. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  38. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Ordered[ZoneOffset]

Inherited from Comparable[ZoneOffset]

Inherited from TemporalAdjuster

Inherited from TemporalAccessor

Inherited from ZoneId

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped