Module qilletni.api

Package dev.qilletni.api.lang.types.entity

Interface EntityDefinition

public interface EntityDefinition

Defines an entity and its properties, functions, etc.

Method Summary

Modifier and Type	Method	Description
EntityType	createInstance(QilletniType... constructorParams)	Creates a new instance of the EntityType this definition represents, with the given constructor parameters in the order defined.
EntityType	createInstance(List<QilletniType> constructorParams)	Creates a new instance of the EntityType this definition represents, with the given constructor parameters in the order defined.
StaticEntityType	createStaticInstance()	Gets a static instance of the entity, used for invoking static methods.
QilletniTypeClass<EntityType>	getQilletniTypeClass()	Gets the QilletniTypeClass for the entity definition.
String	getTypeName()	Gets the name of the entity.
Map<String,UninitializedType>	getUninitializedParams()	Gets all fields of the entity that do not have a value assigned to them.

Method Details

createInstance

EntityType createInstance(List<QilletniType> constructorParams)

Creates a new instance of the EntityType this definition represents, with the given constructor parameters in the order defined.

Parameters:

constructorParams - The parameters of the entity's constructor

Returns:

The created EntityType

createInstance

EntityType createInstance(QilletniType... constructorParams)

Creates a new instance of the EntityType this definition represents, with the given constructor parameters in the order defined.

Parameters:

constructorParams - The parameters of the entity's constructor

Returns:

The created EntityType

createStaticInstance

StaticEntityType createStaticInstance()

Gets a static instance of the entity, used for invoking static methods.

Returns:

The created StaticEntityType

getTypeName

String getTypeName()

Gets the name of the entity.

Returns:

The entity's name

getUninitializedParams

Map<String,UninitializedType> getUninitializedParams()

Gets all fields of the entity that do not have a value assigned to them. These are what makes up the entity's constructor, as all fields must have a value.

Returns:

The name, value list of all fields without a value yet

getQilletniTypeClass

QilletniTypeClass<EntityType> getQilletniTypeClass()

Gets the QilletniTypeClass for the entity definition. This is specific to this definition, but still holds a type of EntityType.

Returns:

The type class of the entity