Package com.winterhavenmc.library.messagebuilder.pipeline.formatters.duration

Record Class BoundedDuration

java.lang.Object
java.lang.Record
com.winterhavenmc.library.messagebuilder.pipeline.formatters.duration.BoundedDuration
Record Components:
duration - the time-based duration to format
precision - the lowest ChronoUnit to include in the formatted result
public record BoundedDuration(Duration duration, ChronoUnit precision) extends Record
A simple data container that encapsulates a Duration and its corresponding lower bound of precision, represented by a ChronoUnit.

This record is typically used in conjunction with duration formatters to specify not only the length of time to be formatted, but also the level of detail or granularity to include in the formatted output (e.g., rounding to the nearest minute, second, etc.).

For example, a BoundedDuration of Duration.ofSeconds(4110) with ChronoUnit.MINUTES as the precision might format to "1 hour, 8 minutes" rather than "1 hour, 8 minutes and 30 seconds", depending on the formatter implementation.

See Also:

  • Constructor Details

    • BoundedDuration

      public BoundedDuration(Duration duration, ChronoUnit precision)
      Creates an instance of a BoundedDuration record class.
      Parameters:
      duration - the value for the duration record component
      precision - the value for the precision record component

  • Method Details

    • 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.

    • duration

      public Duration duration()
      Returns the value of the duration record component.
      Returns:
      the value of the duration record component

    • precision

      public ChronoUnit precision()
      Returns the value of the precision record component.
      Returns:
      the value of the precision record component