Record Class CompiledFormat

java.lang.Object
java.lang.Record
io.github.connellite.format.CompiledFormat

public record CompiledFormat(List<FormatSegment> segments, int patternLength) extends Record
Parsed format pattern; build with Fmt.compile(CharSequence) and reuse across Fmt.format(CompiledFormat, Object...) / Fmt.formatTo(java.lang.Appendable, java.lang.CharSequence, java.lang.Object...) calls.

Opaque handle: construct only via Fmt.compile(java.lang.CharSequence). Segment accessors exist for the formatting engine in this module and are not a supported client API.

  • Constructor Details

    • CompiledFormat

      public CompiledFormat(List<FormatSegment> segments, int patternLength)
      Creates an instance of a CompiledFormat record class.
      Parameters:
      segments - the value for the segments record component
      patternLength - the value for the patternLength 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      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.
    • segments

      public List<FormatSegment> segments()
      Returns the value of the segments record component.
      Returns:
      the value of the segments record component
    • patternLength

      public int patternLength()
      Returns the value of the patternLength record component.
      Returns:
      the value of the patternLength record component