Record Class MainEntryTargetTuple

java.lang.Object

java.lang.Record

org.ek9lang.compiler.backend.MainEntryTargetTuple

Record Components:

programEntryPoint - the programs this entry point must be able to launch

compilerFlags - compiler configuration - also selects the target visitor

fileHandling - directory utilities for targets that need them

outputDirectory - the root the generated entry point is named relative to

sink - where the generated bytes go, so the entry point travels with every other generated class rather than being the one thing still welded to the filesystem. See ConstructOutputSink.

public record MainEntryTargetTuple(ProgramEntryPointInstr programEntryPoint, CompilerFlags compilerFlags, FileHandling fileHandling, File outputDirectory, ConstructOutputSink sink)
extends Record

Contains all the information needed for target-specific visitors to generate main entry points. Each visitor can determine its own file naming conventions and output handling.

Constructor Summary

Constructors

Constructor	Description
MainEntryTargetTuple(ProgramEntryPointInstr programEntryPoint, CompilerFlags compilerFlags, FileHandling fileHandling, File outputDirectory, ConstructOutputSink sink)	Creates an instance of a MainEntryTargetTuple record class.

Method Summary

Modifier and Type	Method	Description
CompilerFlags	compilerFlags()	Returns the value of the compilerFlags record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
FileHandling	fileHandling()	Returns the value of the fileHandling record component.
final int	hashCode()	Returns a hash code value for this object.
File	outputDirectory()	Returns the value of the outputDirectory record component.
ProgramEntryPointInstr	programEntryPoint()	Returns the value of the programEntryPoint record component.
ConstructOutputSink	sink()	Returns the value of the sink 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

MainEntryTargetTuple

public MainEntryTargetTuple(ProgramEntryPointInstr programEntryPoint,
 CompilerFlags compilerFlags,
 FileHandling fileHandling,
 File outputDirectory,
 ConstructOutputSink sink)

Creates an instance of a MainEntryTargetTuple record class.

Parameters:

programEntryPoint - the value for the programEntryPoint record component

compilerFlags - the value for the compilerFlags record component

fileHandling - the value for the fileHandling record component

outputDirectory - the value for the outputDirectory record component

sink - the value for the sink 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.

programEntryPoint

public ProgramEntryPointInstr programEntryPoint()

Returns the value of the programEntryPoint record component.

Returns:

the value of the programEntryPoint record component

compilerFlags

public CompilerFlags compilerFlags()

Returns the value of the compilerFlags record component.

Returns:

the value of the compilerFlags record component

fileHandling

public FileHandling fileHandling()

Returns the value of the fileHandling record component.

Returns:

the value of the fileHandling record component

outputDirectory

public File outputDirectory()

Returns the value of the outputDirectory record component.

Returns:

the value of the outputDirectory record component

sink

public ConstructOutputSink sink()

Returns the value of the sink record component.

Returns:

the value of the sink record component