Package dev.omnist.document

Record Class TimeValue

java.lang.Object
java.lang.Record
dev.omnist.document.TimeValue
Record Components:
time - the time of day (required)
offset - the UTC zone offset, or null if un-offset
public record TimeValue(LocalTime time, ZoneOffset offset) extends Record
Represents a time of day with optional UTC offset (omnist-spec ยง2.2.1).

  • Constructor Details

    • TimeValue

      public TimeValue(LocalTime time, ZoneOffset offset)
      Creates an instance of a TimeValue record class.
      Parameters:
      time - the value for the time record component
      offset - the value for the offset record component

  • Method Details

    • of

      public static TimeValue of(LocalTime time)
      Creates an un-offset time (local time with no UTC offset).
      Parameters:
      time - the time of day; must not be null
      Returns:
      a new TimeValue with offset == null

    • of

      public static TimeValue of(LocalTime time, ZoneOffset offset)
      Creates an offset time with an explicit UTC offset.
      Parameters:
      time - the time of day; must not be null
      offset - the UTC zone offset (e.g. ZoneOffset.UTC); may be null to produce an un-offset value
      Returns:
      a new TimeValue

    • format

      public String format()
      Formats this value as an ISO-8601 string suitable for OML and codec serialization. The format is HH:MM:SS[.fractional] optionally followed by Z for UTC or a numeric offset such as +05:30. Un-offset values omit the trailing timezone designator entirely.
      Returns:
      the ISO-8601 formatted string; never null

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • time

      public LocalTime time()
      Returns the value of the time record component.
      Returns:
      the value of the time record component

    • offset

      public ZoneOffset offset()
      Returns the value of the offset record component.
      Returns:
      the value of the offset record component