Record Class FunctionMetrics

java.lang.Object
java.lang.Record
org.ek9lang.compiler.ir.data.FunctionMetrics
Record Components:
cyclomaticComplexity - Cyclomatic complexity (McCabe) - number of linearly independent paths
cognitiveComplexity - Cognitive complexity (SonarSource methodology) - mental effort to understand
nestingDepth - Maximum nesting level of control structures
statementCount - Number of statements in the function
expressionComplexity - Expression complexity score
injectionCount - Number of DI injection variables (BANG declarations) in this function
couplingCount - Efferent coupling (Ce): distinct external types this construct depends on. A TYPE-level property inherited by each of its operations.
couplingLimit - The genus-specific Ce ceiling this construct was checked against, carried alongside the count so consumers can form the ratio without a genus
defaulted - Whether the compiler generated this operation's body (a default operator or constructor) rather than the author writing one. Provenance, not a measurement — which is why it rides here rather than being inferred downstream from "cognitive 0", a test every trivial hand-written member also passes. A generated body is not an editable site, so change-risk must never NAME it as the worst construct; its coupling is nonetheless real (the generated fold genuinely touches every field type), so it is still scored. See ConstructHexReport.worst().
pure - Whether the operation is marked as pure. Carried for REPORTING only — it feeds no score. Purity bounds how damage travels (a pure construct can only reach its callers, an impure one can also reach code through mutated state) rather than whether the code can be wrong, so it does not belong in a hazard built from complexity and coupling. Its intended use is qualifying afferent coupling: for a pure construct Ca is a complete blast radius, for an impure one it is a lower bound. Emitted now so that reading can be calibrated against real codebases before any scoring rule is committed to.
identity - The construct's JOIN KEY (Aggregate.member, or a bare name for a free function) — CoverageDisplayName.identityForSymbol. Distinct from the display name carried alongside it, which renders a constructor bare and so cannot be matched against any other producer's naming. Null only for callers with no symbol to resolve.
public record FunctionMetrics(int cyclomaticComplexity, int cognitiveComplexity, int nestingDepth, int statementCount, int expressionComplexity, int injectionCount, int couplingCount, int couplingLimit, boolean defaulted, boolean pure, String identity) extends Record
Code quality metrics for a single function/method.

Collected during Phase 5 (Pre-IR Checks) and passed through IR to coverage reports. Enables AI-assisted and human code quality analysis.

These metrics provide significant competitive advantage:

  • Cognitive complexity - SonarQube charges for this; EK9 includes it FREE
  • All metrics integrated with coverage - single unified report

  • Field Details

    • EMPTY

      public static final FunctionMetrics EMPTY
      Empty metrics for functions without collected data.

  • Constructor Details

    • FunctionMetrics

      public FunctionMetrics(int cyclomaticComplexity, int cognitiveComplexity, int nestingDepth, int statementCount, int expressionComplexity, int injectionCount, int couplingCount, int couplingLimit, boolean defaulted, boolean pure, String identity)
      Creates an instance of a FunctionMetrics record class.
      Parameters:
      cyclomaticComplexity - the value for the cyclomaticComplexity record component
      cognitiveComplexity - the value for the cognitiveComplexity record component
      nestingDepth - the value for the nestingDepth record component
      statementCount - the value for the statementCount record component
      expressionComplexity - the value for the expressionComplexity record component
      injectionCount - the value for the injectionCount record component
      couplingCount - the value for the couplingCount record component
      couplingLimit - the value for the couplingLimit record component
      defaulted - the value for the defaulted record component
      pure - the value for the pure record component
      identity - the value for the identity record component

  • Method Details

    • hasHighComplexity

      public boolean hasHighComplexity()
      Check if cyclomatic or cognitive complexity exceeds recommended thresholds.

      Thresholds based on industry standards:

      • Cyclomatic > 10: Function is complex
      • Cognitive > 15: Function is hard to understand
      Returns:
      true if either threshold is exceeded

    • needsAttention

      public boolean needsAttention()
      Check if this function needs attention based on any metric.

      Thresholds:

      • Cyclomatic > 15: Seriously complex
      • Cognitive > 25: Very hard to understand
      • Nesting > 4: Too deeply nested
      Returns:
      true if any threshold is exceeded

    • severityLevel

      @Nonnull public String severityLevel()
      Severity level for attention panel display.
      Returns:
      "critical" if CC > 20 or Cog > 30, "warning" if above thresholds, "ok" otherwise

    • hasData

      public boolean hasData()
      Check if this record has any meaningful data.
      Returns:
      true if any metric is non-zero

    • 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.
      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.

    • cyclomaticComplexity

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

    • cognitiveComplexity

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

    • nestingDepth

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

    • statementCount

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

    • expressionComplexity

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

    • injectionCount

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

    • couplingCount

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

    • couplingLimit

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

    • defaulted

      public boolean defaulted()
      Returns the value of the defaulted record component.
      Returns:
      the value of the defaulted record component

    • pure

      public boolean pure()
      Returns the value of the pure record component.
      Returns:
      the value of the pure record component

    • identity

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