Record Class EnumIteratorImplDetails

java.lang.Object

java.lang.Record

org.ek9lang.compiler.ir.data.EnumIteratorImplDetails

Record Components:

enumTypeName - Fully qualified name of the iterated type (base or constrained enum)

superTypeName - Fully qualified name of the parameterized Iterator type to extend

enumValues - Value names to yield (all values for a base enum; the constrained SUBSET otherwise)

baseEnumTypeName - Base enum FQN when enumTypeName is a CONSTRAINED enum; null for a base enum

baseOrdinals - For a constrained enum, the base ordinal of each value in enumValues (parallel list); empty for a base enum (index is the ordinal)

resultVariable - Variable name to store the iterator instance

debugInfo - Debug information for source mapping

public record EnumIteratorImplDetails(String enumTypeName, String superTypeName, List<String> enumValues, String baseEnumTypeName, List<Integer> baseOrdinals, String resultVariable, DebugInfo debugInfo)
extends Record

Details for the ENUM_ITERATOR_IMPL IR instruction.

Contains all information needed by backends to generate an efficient iterator implementation for an enumeration type.

Two shapes:

• Base enum (via forBaseEnum(String, String, List, String, DebugInfo)): each element is an instance of enumTypeName constructed with _ordinal = its index and _name = the value name.
• Constrained enum (via forConstrainedEnum(String, String, List, String, List, String, DebugInfo)): enumTypeName is the constrained type (e.g. module::RedSuit) and baseEnumTypeName is the base it wraps (e.g. module::CardSuit). Each element is a base value (name + its base ordinal from baseOrdinals) WRAPPED in the constrained type via its (baseEnum) constructor, so iteration yields the constrained SUBSET as constrained instances.

Constructor Summary

Constructors

Constructor	Description
EnumIteratorImplDetails(String enumTypeName, String superTypeName, List<String> enumValues, String baseEnumTypeName, List<Integer> baseOrdinals, String resultVariable, DebugInfo debugInfo)	Canonical constructor with validation and defensive copies.

Method Summary

Modifier and Type	Method	Description
String	baseEnumTypeName()	Returns the value of the baseEnumTypeName record component.
List<Integer>	baseOrdinals()	Returns the value of the baseOrdinals record component.
DebugInfo	debugInfo()	Returns the value of the debugInfo record component.
String	enumTypeName()	Returns the value of the enumTypeName record component.
int	enumValueCount()	Get the number of enum values.
List<String>	enumValues()	Returns the value of the enumValues record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
static EnumIteratorImplDetails	forBaseEnum(String enumTypeName, String superTypeName, List<String> enumValues, String resultVariable, DebugInfo debugInfo)	Details for a base enumeration (each value is a fresh enumTypeName instance, ordinal = index).
static EnumIteratorImplDetails	forConstrainedEnum(String enumTypeName, String superTypeName, List<String> enumValues, String baseEnumTypeName, List<Integer> baseOrdinals, String resultVariable, DebugInfo debugInfo)	Details for a constrained enumeration: yield the enumValues SUBSET (with their baseOrdinals) of baseEnumTypeName, each WRAPPED in enumTypeName via its (baseEnum) constructor.
boolean	hasEnumValues()	Check if there are any enum values.
final int	hashCode()	Returns a hash code value for this object.
boolean	isConstrainedEnum()	True when this iterates a constrained enum (each yielded value is wrapped in enumTypeName).
String	resultVariable()	Returns the value of the resultVariable record component.
String	superTypeName()	Returns the value of the superTypeName record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

EnumIteratorImplDetails

public EnumIteratorImplDetails(String enumTypeName,
 String superTypeName,
 List<String> enumValues,
 String baseEnumTypeName,
 List<Integer> baseOrdinals,
 String resultVariable,
 DebugInfo debugInfo)

Canonical constructor with validation and defensive copies.

Method Details

forBaseEnum

public static EnumIteratorImplDetails forBaseEnum(String enumTypeName,
 String superTypeName,
 List<String> enumValues,
 String resultVariable,
 DebugInfo debugInfo)

Details for a base enumeration (each value is a fresh enumTypeName instance, ordinal = index).

forConstrainedEnum

public static EnumIteratorImplDetails forConstrainedEnum(String enumTypeName,
 String superTypeName,
 List<String> enumValues,
 String baseEnumTypeName,
 List<Integer> baseOrdinals,
 String resultVariable,
 DebugInfo debugInfo)

Details for a constrained enumeration: yield the enumValues SUBSET (with their baseOrdinals) of baseEnumTypeName, each WRAPPED in enumTypeName via its (baseEnum) constructor.

isConstrainedEnum

public boolean isConstrainedEnum()

True when this iterates a constrained enum (each yielded value is wrapped in enumTypeName).

enumValueCount

public int enumValueCount()

Get the number of enum values.

hasEnumValues

public boolean hasEnumValues()

Check if there are any enum values.

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.

enumTypeName

public String enumTypeName()

Returns the value of the enumTypeName record component.

Returns:

the value of the enumTypeName record component

superTypeName

public String superTypeName()

Returns the value of the superTypeName record component.

Returns:

the value of the superTypeName record component

enumValues

public List<String> enumValues()

Returns the value of the enumValues record component.

Returns:

the value of the enumValues record component

baseEnumTypeName

public String baseEnumTypeName()

Returns the value of the baseEnumTypeName record component.

Returns:

the value of the baseEnumTypeName record component

baseOrdinals

public List<Integer> baseOrdinals()

Returns the value of the baseOrdinals record component.

Returns:

the value of the baseOrdinals record component

resultVariable

public String resultVariable()

Returns the value of the resultVariable record component.

Returns:

the value of the resultVariable record component

debugInfo

public DebugInfo debugInfo()

Returns the value of the debugInfo record component.

Returns:

the value of the debugInfo record component