Package net.mcreator.workspace

Class Workspace

java.lang.Object

net.mcreator.workspace.Workspace

All Implemented Interfaces:

Closeable, AutoCloseable, IGeneratorProvider, IWorkspaceProvider

public class Workspace
extends Object
implements Closeable, IGeneratorProvider

Field Summary

Fields

Modifier and Type	Field	Description
protected WorkspaceFileManager	fileManager
protected FolderElement	foldersRoot
protected Generator	generator

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Workspace(WorkspaceSettings workspaceSettings)

Method Summary

Modifier and Type	Method	Description
void	addLanguage(String language, LinkedHashMap<String,String> data)
void	addModElement(ModElement element)
void	addSoundElement(SoundElement element)
void	addTagElement(TagElement element)
void	addVariableElement(VariableElement element)
void	bindToNewWorkspaceFile(File workspaceFile)
boolean	checkFailingGradleDependenciesAndClear()
void	close()
boolean	containsModElement(String elementName)
static Workspace	createWorkspace(File workspaceFile, WorkspaceSettings workspaceSettings)
boolean	equals(Object o)
CreativeTabsOrder	getCreativeTabsOrder()
WorkspaceFileManager	getFileManager()
WorkspaceFolderManager	getFolderManager()
FolderElement	getFoldersRoot()
Generator	getGenerator()
Map<String,LinkedHashMap<String,String>>	getLanguageMap()
long	getMCreatorVersion()
Object	getMetadata(String key)
ModElement	getModElementByName(String elementName)
ModElementManager	getModElementManager()
Collection<ModElement>	getModElements()
Collection<SoundElement>	getSoundElements()
Map<TagElement,ArrayList<String>>	getTagElements()
VariableElement	getVariableElementByName(String elementName)
Collection<VariableElement>	getVariableElements()
Workspace	getWorkspace()
WorkspaceInfo	getWorkspaceInfo()
WorkspaceSettings	getWorkspaceSettings()
WorkspaceUserSettings	getWorkspaceUserSettings()
int	hashCode()
boolean	isRegenerateRequired()
void	loadStoredDataFrom(Workspace other)
void	markDirty()
void	markFailingGradleDependencies()
void	putMetadata(String key, Object data)
static Workspace	readFromFS(File workspaceFile, Window ui)
static Workspace	readFromFSUnsafe(File workspaceFile, GeneratorConfiguration generatorConfiguration)	Unsafe version of readFromFS with supported generator type checks omitted.
void	reloadFolderStructure()
void	reloadModElements()
void	removeLocalizationEntryByKey(String key)
void	removeLocalizationLanguage(String language)
void	removeModElement(ModElement element)
void	removeSoundElement(SoundElement element)
void	removeTagElement(TagElement element)
void	removeVariableElement(VariableElement element)
void	requireRegenerate()
void	resetModElementCompilesStatus()
void	setLocalization(String key, String value)
void	setMCreatorVersion(long mcreatorVersion)
void	setWorkspaceSettings(WorkspaceSettings workspaceSettings)
void	switchGenerator(String generatorName)
String	toString()
void	updateLanguage(String language, LinkedHashMap<String,String> data)

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.mcreator.generator.IGeneratorProvider

getGeneratorConfiguration, getGeneratorStats

Methods inherited from interface net.mcreator.workspace.IWorkspaceProvider

getWorkspaceFolder

Field Details

foldersRoot

protected FolderElement foldersRoot

fileManager

protected transient WorkspaceFileManager fileManager

generator

protected transient Generator generator

Constructor Details

Workspace

protected Workspace(WorkspaceSettings workspaceSettings)

Method Details

getWorkspaceSettings

public WorkspaceSettings getWorkspaceSettings()

Specified by:

getWorkspaceSettings in interface IWorkspaceProvider

setWorkspaceSettings

public void setWorkspaceSettings(WorkspaceSettings workspaceSettings)

getModElements

public Collection<ModElement> getModElements()

Returns:

UNMODIFIABLE! collection of mod elements

getVariableElements

public Collection<VariableElement> getVariableElements()

Returns:

UNMODIFIABLE! collection of variable elements

getSoundElements

public Collection<SoundElement> getSoundElements()

Returns:

UNMODIFIABLE! collection of sound elements

getCreativeTabsOrder

public CreativeTabsOrder getCreativeTabsOrder()

getTagElements

public Map<TagElement,ArrayList<String>> getTagElements()

getLanguageMap

public Map<String,LinkedHashMap<String,String>> getLanguageMap()

getFoldersRoot

public FolderElement getFoldersRoot()

getWorkspaceInfo

@Nonnull
public WorkspaceInfo getWorkspaceInfo()

containsModElement

public boolean containsModElement(String elementName)

getModElementByName

public ModElement getModElementByName(String elementName)

getVariableElementByName

public VariableElement getVariableElementByName(String elementName)

resetModElementCompilesStatus

public void resetModElementCompilesStatus()

addLanguage

public void addLanguage(String language,
 LinkedHashMap<String,String> data)

updateLanguage

public void updateLanguage(String language,
 LinkedHashMap<String,String> data)

setLocalization

public void setLocalization(String key,
 String value)

removeLocalizationEntryByKey

public void removeLocalizationEntryByKey(String key)

removeLocalizationLanguage

public void removeLocalizationLanguage(String language)

addModElement

public void addModElement(ModElement element)

addVariableElement

public void addVariableElement(VariableElement element)

addTagElement

public void addTagElement(TagElement element)

addSoundElement

public void addSoundElement(SoundElement element)

removeModElement

public void removeModElement(ModElement element)

removeVariableElement

public void removeVariableElement(VariableElement element)

removeTagElement

public void removeTagElement(TagElement element)

removeSoundElement

public void removeSoundElement(SoundElement element)

putMetadata

public void putMetadata(String key,
 @Nullable
 Object data)

getMetadata

@Nullable
public Object getMetadata(String key)

setMCreatorVersion

public void setMCreatorVersion(long mcreatorVersion)

getMCreatorVersion

public long getMCreatorVersion()

getFileManager

public WorkspaceFileManager getFileManager()

Specified by:

getFileManager in interface IWorkspaceProvider

getFolderManager

public WorkspaceFolderManager getFolderManager()

Specified by:

getFolderManager in interface IWorkspaceProvider

getWorkspaceUserSettings

public WorkspaceUserSettings getWorkspaceUserSettings()

Specified by:

getWorkspaceUserSettings in interface IWorkspaceProvider

getGenerator

public Generator getGenerator()

Specified by:

getGenerator in interface IGeneratorProvider

getModElementManager

public ModElementManager getModElementManager()

Specified by:

getModElementManager in interface IWorkspaceProvider

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

markDirty

public void markDirty()

reloadModElements

public void reloadModElements()

reloadFolderStructure

public void reloadFolderStructure()

switchGenerator

public void switchGenerator(String generatorName)

bindToNewWorkspaceFile

public void bindToNewWorkspaceFile(File workspaceFile)

markFailingGradleDependencies

public void markFailingGradleDependencies()

checkFailingGradleDependenciesAndClear

public boolean checkFailingGradleDependenciesAndClear()

getWorkspace

@Nonnull
public Workspace getWorkspace()

Specified by:

getWorkspace in interface IWorkspaceProvider

readFromFS

public static Workspace readFromFS(File workspaceFile,
 @Nullable
 Window ui)
                            throws UnsupportedGeneratorException,
CorruptedWorkspaceFileException,
FileNotFoundException,
MissingGeneratorFeaturesException

Throws:

UnsupportedGeneratorException

CorruptedWorkspaceFileException

FileNotFoundException

MissingGeneratorFeaturesException

readFromFSUnsafe

public static Workspace readFromFSUnsafe(File workspaceFile,
 GeneratorConfiguration generatorConfiguration)
                                  throws MissingGeneratorFeaturesException

Unsafe version of readFromFS with supported generator type checks omitted. Only intended to be used by tests. Instead of checking for supported generator, it will force the generator specified by generatorConfiguration.

Parameters:

workspaceFile - File containing the output workspace definition.

generatorConfiguration - If same as workspace, nothing is done, otherwise regenerateRequired is set to true.

Returns:

Workspace object for the given file

Throws:

MissingGeneratorFeaturesException

createWorkspace

public static Workspace createWorkspace(File workspaceFile,
 WorkspaceSettings workspaceSettings)

requireRegenerate

public void requireRegenerate()

isRegenerateRequired

public boolean isRegenerateRequired()

loadStoredDataFrom

public void loadStoredDataFrom(Workspace other)

Parameters:

other - The workspace to copy elements and settings from.