Package com.vaadin.copilot

Record Class ComponentEventCollector

java.lang.Object
java.lang.Record
com.vaadin.copilot.ComponentEventCollector
Record Components:
vaadinContext - Vaadin context used to detect Spring and resolve the application's base package.
public record ComponentEventCollector(com.vaadin.flow.server.VaadinContext vaadinContext) extends Record
Collects component event listener methods (methods returning Registration) from Vaadin Flow components found on the classpath, and optionally maps selected events to React-style attribute names.

The scan includes com.vaadin.flow and the user's application base package (when Spring is available).

  • Constructor Details

    • ComponentEventCollector

      public ComponentEventCollector(com.vaadin.flow.server.VaadinContext vaadinContext)
      Creates an instance of a ComponentEventCollector record class.
      Parameters:
      vaadinContext - the value for the vaadinContext record component

  • Method Details

    • getResult

      public ComponentEventCollector.EventCollectionResult getResult()
      Scans the classpath for Vaadin Flow Component subclasses and collects listener-style methods.

      A method is considered a candidate event listener registration when:

      • Its return type erases to Registration.
      • It is not a "signal" registration method (parameters referencing com.vaadin.signals).
      • It is not listed in methodNamesToIgnore.
      The returned maps are sorted by a priority derived from the method name, then by method name.
      Returns:
      the collected events grouped by component class and (when applicable) by Tag name

    • resolveErasedTypeName

      public static String resolveErasedTypeName(io.github.classgraph.TypeSignature type)
      Resolves an "erased" (raw) type name from a TypeSignature.

      This is used to compare method return types against Registration without requiring generic resolution.

      Parameters:
      type - the type signature to resolve
      Returns:
      the fully qualified class name for class references, an array type name for array signatures, or a simple-name representation for other signature kinds

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

    • vaadinContext

      public com.vaadin.flow.server.VaadinContext vaadinContext()
      Returns the value of the vaadinContext record component.
      Returns:
      the value of the vaadinContext record component