Package net.mcreator.generator

Class Generator

java.lang.Object

net.mcreator.generator.Generator

All Implemented Interfaces:

Closeable, AutoCloseable, IGenerator, IGeneratorProvider, IWorkspaceProvider

public class Generator
extends Object
implements IGenerator, Closeable

Field Summary

Fields

Modifier and Type	Field	Description
static final Map<String,GeneratorConfiguration>	GENERATOR_CACHE

Constructor Summary

Constructors

Constructor	Description
Generator(Workspace workspace)

Method Summary

Modifier and Type	Method	Description
void	close()
boolean	generateBase()	Generates the generator mod base files.
boolean	generateBase(boolean formatAndOrganiseImports)	Generates the generator mod base files and writes them to disk.
boolean	generateElement(GeneratableElement element)	GeneratableElement should be saved AFTER this method is called, not before as it can be altered in this process
List<GeneratorFile>	generateElement(GeneratableElement element, boolean formatAndOrganiseImports)
List<GeneratorFile>	generateElement(GeneratableElement element, boolean formatAndOrganiseImports, boolean performFSTasks)
BaseDataModelProvider	getBaseDataModelProvider()
List<String>	getElementLocalizationKeys(GeneratableElement element)
GeneratorConfiguration	getGeneratorConfiguration()
String	getGeneratorName()
File	getGeneratorPackageRoot()
List<GeneratorTemplate>	getGlobalTemplatesListForDefinition(Map<?,?> map, boolean performFSTasks, AtomicInteger templateID)
List<GeneratorTemplate>	getGlobalTemplatesListForModElementType(ModElementType<?> type, boolean performFSTasks, AtomicInteger templateID)
GeneratorGradleCache	getGradleCache()
org.gradle.tooling.ProjectConnection	getGradleProjectConnection()
File	getLangFilesRoot()
MinecraftCodeProvider	getMinecraftCodeProvider()
List<GeneratorTemplate>	getModBaseGeneratorTemplatesList(boolean performFSTasks)
List<GeneratorTemplate>	getModElementGeneratorTemplatesList(GeneratableElement generatableElement)
List<GeneratorTemplatesList>	getModElementListTemplates(GeneratableElement generatableElement)
ModElement	getModElementThisFileBelongsTo(File file)
ProjectJarManager	getProjectJarManager()
TemplateGenerator	getTemplateGeneratorFromName(String name)
Workspace	getWorkspace()
void	loadOrCreateGradleCaches()
void	reloadGradleCaches()
void	removeElementFilesAndWorkspaceLinks(GeneratableElement generatableElement)
void	runResourceSetupTasks()
void	setGradleCache(GeneratorGradleCache generatorGradleCache)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.mcreator.generator.IGenerator

getFullGeneratorVersion, getGeneratorBuildFileVersion, getGeneratorMinecraftVersion, getMappings, getModAssetsRoot, getModDataRoot, getResourceRoot, getSourceRoot

Methods inherited from interface net.mcreator.generator.IGeneratorProvider

getGenerator, getGeneratorStats

Methods inherited from interface net.mcreator.workspace.IWorkspaceProvider

getFileManager, getFolderManager, getModElementManager, getWorkspaceFolder, getWorkspaceSettings

Field Details

GENERATOR_CACHE

public static final Map<String,GeneratorConfiguration> GENERATOR_CACHE

Constructor Details

Generator

public Generator(@Nonnull
 Workspace workspace)

Method Details

getWorkspace

@Nonnull
public Workspace getWorkspace()

Specified by:

getWorkspace in interface IWorkspaceProvider

getGeneratorConfiguration

public GeneratorConfiguration getGeneratorConfiguration()

Specified by:

getGeneratorConfiguration in interface IGeneratorProvider

getTemplateGeneratorFromName

public TemplateGenerator getTemplateGeneratorFromName(String name)

getGeneratorName

public String getGeneratorName()

getMinecraftCodeProvider

public MinecraftCodeProvider getMinecraftCodeProvider()

getBaseDataModelProvider

public BaseDataModelProvider getBaseDataModelProvider()

getGeneratorPackageRoot

public File getGeneratorPackageRoot()

getLangFilesRoot

public File getLangFilesRoot()

generateBase

public boolean generateBase()

Generates the generator mod base files. Formats the imports in the generated Java code.

Returns:

true if generator generated all files without any errors

generateBase

public boolean generateBase(boolean formatAndOrganiseImports)

Generates the generator mod base files and writes them to disk.

Parameters:

formatAndOrganiseImports - true if imports should be formatted

Returns:

true if generator generated all files without any errors

generateElement

public boolean generateElement(GeneratableElement element)

GeneratableElement should be saved AFTER this method is called, not before as it can be altered in this process

Parameters:

element - GeneratableElement to generate code and resources for

Returns:

true if generation succeeds

generateElement

@Nonnull
public List<GeneratorFile> generateElement(GeneratableElement element,
 boolean formatAndOrganiseImports)
                                    throws TemplateGeneratorException

Throws:

TemplateGeneratorException

generateElement

@Nonnull
public List<GeneratorFile> generateElement(GeneratableElement element,
 boolean formatAndOrganiseImports,
 boolean performFSTasks)
                                    throws TemplateGeneratorException

Throws:

TemplateGeneratorException

getElementLocalizationKeys

public List<String> getElementLocalizationKeys(GeneratableElement element)

removeElementFilesAndWorkspaceLinks

public void removeElementFilesAndWorkspaceLinks(GeneratableElement generatableElement)

getModBaseGeneratorTemplatesList

@Nonnull
public List<GeneratorTemplate> getModBaseGeneratorTemplatesList(boolean performFSTasks)

getGlobalTemplatesListForModElementType

public List<GeneratorTemplate> getGlobalTemplatesListForModElementType(ModElementType<?> type,
 boolean performFSTasks,
 AtomicInteger templateID)

getGlobalTemplatesListForDefinition

public List<GeneratorTemplate> getGlobalTemplatesListForDefinition(@Nullable
 Map<?,?> map,
 boolean performFSTasks,
 AtomicInteger templateID)

getModElementGeneratorTemplatesList

@Nonnull
public List<GeneratorTemplate> getModElementGeneratorTemplatesList(GeneratableElement generatableElement)

getModElementListTemplates

@Nonnull
public List<GeneratorTemplatesList> getModElementListTemplates(GeneratableElement generatableElement)

getModElementThisFileBelongsTo

public ModElement getModElementThisFileBelongsTo(File file)

runResourceSetupTasks

public void runResourceSetupTasks()

getGradleProjectConnection

@Nullable
public org.gradle.tooling.ProjectConnection getGradleProjectConnection()

getProjectJarManager

@Nullable
public ProjectJarManager getProjectJarManager()

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

loadOrCreateGradleCaches

public void loadOrCreateGradleCaches()
                              throws GradleCacheImportFailedException

Throws:

GradleCacheImportFailedException

reloadGradleCaches

public void reloadGradleCaches()

getGradleCache

public GeneratorGradleCache getGradleCache()

setGradleCache

public void setGradleCache(GeneratorGradleCache generatorGradleCache)