Record Class ProgramDetails

java.lang.Object
java.lang.Record
org.ek9lang.compiler.ir.data.ProgramDetails
public record ProgramDetails(String qualifiedName, List<ParameterDetails> parameterSignature, @Nullable String applicationName, @Nullable String returnType) extends Record
Represents details about an EK9 program for the PROGRAM_ENTRY_POINT_BLOCK. Contains all information needed by backends to generate type-safe program selection and argument conversion logic.

  • Constructor Details

    • ProgramDetails

      public ProgramDetails(String qualifiedName, List<ParameterDetails> parameterSignature, @Nullable String applicationName, @Nullable String returnType)
      Creates an instance of a ProgramDetails record class.
      Parameters:
      qualifiedName - the value for the qualifiedName record component
      parameterSignature - the value for the parameterSignature record component
      applicationName - the value for the applicationName record component
      returnType - the value for the returnType record component

  • Method Details

    • hasApplication

      public boolean hasApplication()
      Check if this program has an associated Application for dependency injection.

    • hasReturn

      public boolean hasReturn()
      Check if this program declares a return value. An EK9 program may optionally return an Integer (only an Integer, per E07590) which becomes the OS process exit code; a program with no return exits 0 on normal completion. returnType is the EK9 fully-qualified type name of the returned value (e.g. org.ek9.lang::Integer), or null for no return.

    • toString

      @Nonnull public 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.

    • qualifiedName

      public String qualifiedName()
      Returns the value of the qualifiedName record component.
      Returns:
      the value of the qualifiedName record component

    • parameterSignature

      public List<ParameterDetails> parameterSignature()
      Returns the value of the parameterSignature record component.
      Returns:
      the value of the parameterSignature record component

    • applicationName

      @Nullable public String applicationName()
      Returns the value of the applicationName record component.
      Returns:
      the value of the applicationName record component

    • returnType

      @Nullable public String returnType()
      Returns the value of the returnType record component.
      Returns:
      the value of the returnType record component