Record Class IDEHeartbeatResponse

java.lang.Object
java.lang.Record
com.vaadin.copilot.ide.IDEHeartbeatResponse
Record Components:
hasCompilationError - a Boolean indicating whether there is a compilation error; may be null if the status is unknown
filesContainCompilationErrors - a list of file paths that currently contain compilation errors; may be null or empty if no errors are present

public record IDEHeartbeatResponse(Boolean hasCompilationError, List<String> filesContainCompilationErrors) extends Record
Represents the response payload from the IDE heartbeat mechanism.

This response provides information about the current compilation status of the project and optionally a list of files that contain compilation errors. It is used to communicate IDE state back to development tools for status monitoring or UI feedback.

  • Constructor Details

    • IDEHeartbeatResponse

      public IDEHeartbeatResponse(Boolean hasCompilationError, List<String> filesContainCompilationErrors)
      Creates an instance of a IDEHeartbeatResponse record class.
      Parameters:
      hasCompilationError - the value for the hasCompilationError record component
      filesContainCompilationErrors - the value for the filesContainCompilationErrors 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.
    • hasCompilationError

      public Boolean hasCompilationError()
      Returns the value of the hasCompilationError record component.
      Returns:
      the value of the hasCompilationError record component
    • filesContainCompilationErrors

      public List<String> filesContainCompilationErrors()
      Returns the value of the filesContainCompilationErrors record component.
      Returns:
      the value of the filesContainCompilationErrors record component