Class McbsEditorFileTab

java.lang.Object

com.thecsdev.betterstats.api.mcbs.controller.tab.McbsEditorTab

com.thecsdev.betterstats.api.mcbs.controller.tab.McbsEditorFileTab

public final class McbsEditorFileTab
extends McbsEditorTab

This Class serves as the controller component in the MVC architecture. Its job is to represent a "tab" in a given McbsEditor, that manages interactions and operations related to a specific McbsFile instance.

Field Summary

Fields

Modifier and Type	Field	Description
static final McbsEditorFileTab	LOCALPLAYER	"Special" McbsEditorTab instance, specifically for interfacing with LocalPlayerStatsProvider data.

Constructor Summary

Constructors

Constructor	Description
McbsEditorFileTab(@NotNull McbsFile mcbsFile)
McbsEditorFileTab(@NotNull Path path)

Method Summary

Modifier and Type	Method	Description
final boolean	equals(@Nullable Object obj)	To prevent the McbsEditors from opening duplicate tabs, it is essential to override this method along with McbsEditorTab.hashCode() to enforce non-fungibility.
final @NotNull StatsView	getCurrentView()	Returns the StatsView instance that is currently selected for this McbsEditorFileTab.
final @NotNull net.minecraft.network.chat.Component	getDisplayName()	This method provides the display name that will be shown in the user interface for this particular tab within an McbsEditor.
final @NotNull Map<net.minecraft.resources.Identifier, McbsGoal>	getGoals()	Returns a Map view of the McbsGoal instances this McbsEditorFileTab is managing.
final @NotNull McbsFile	getMcbsFile()	Returns the raw unfiltered McbsFile instance this MVC controller controls.
final StatsView.Filters	getStatFilters()	Returns the StatsView.Filters instance that is used for this McbsEditorFileTab.
final @NotNull com.thecsdev.commonmc.api.stats.IStatsProvider	getStats()	Returns an IStatsProvider view of the McbsStats instance this McbsEditorFileTab is managing.
final int	hashCode()	To prevent the McbsEditors from opening duplicate tabs, it is essential to override this method along with McbsEditorTab.equals(Object) to enforce non-fungibility.
final void	loadFrom(@NotNull Path file)	Loads the McbsFile data from the specified file into this McbsEditorFileTab's McbsFile instance.
final void	loadStatsFrom(@NotNull com.thecsdev.commonmc.api.stats.IStatsProvider statsProvider)	Loads the McbsStats data from the specified IStatsProvider into this McbsEditorFileTab's McbsFile instance.
final void	putGoal(@NotNull McbsGoal goal)	Puts an McbsGoal into McbsFile.getGoals().
final void	putGoal(@NotNull net.minecraft.resources.Identifier id, @NotNull McbsGoal goal)	Puts an McbsGoal into McbsFile.getGoals() with a specific Identifier key.
final boolean	removeGoal(@NotNull McbsGoal goal)	Removes an McbsGoal from the McbsFile.
final boolean	removeGoal(@NotNull net.minecraft.resources.Identifier id)	Removes an McbsGoal from the McbsFile.
final void	saveAs(@NotNull Path file)	Saves the McbsFile data of this McbsEditorFileTab to the specified file.
final void	setCurrentView(@NotNull StatsView view)	Sets the StatsView instance that is currently selected for this McbsEditorFileTab.

Methods inherited from class McbsEditorTab

addEditCount, getEditCount

Methods inherited from class Object

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

Field Details

LOCALPLAYER

@Internal
public static final McbsEditorFileTab LOCALPLAYER

"Special" McbsEditorTab instance, specifically for interfacing with LocalPlayerStatsProvider data.

Constructor Details

McbsEditorFileTab

public McbsEditorFileTab(@NotNull
 @NotNull McbsFile mcbsFile)
                  throws NullPointerException

Throws:

NullPointerException

McbsEditorFileTab

public McbsEditorFileTab(@NotNull
 @NotNull Path path)
                  throws NullPointerException,
IOException

Throws:

NullPointerException

IOException

Method Details

hashCode

public final int hashCode()

Description copied from class: McbsEditorTab

To prevent the McbsEditors from opening duplicate tabs, it is essential to override this method along with McbsEditorTab.equals(Object) to enforce non-fungibility.

Specified by:

hashCode in class McbsEditorTab

See Also:

• Object.hashCode()

equals

public final boolean equals(@Nullable
 @Nullable Object obj)

Description copied from class: McbsEditorTab

To prevent the McbsEditors from opening duplicate tabs, it is essential to override this method along with McbsEditorTab.hashCode() to enforce non-fungibility.

Specified by:

equals in class McbsEditorTab

See Also:

• Object.equals(Object)

getDisplayName

@NotNull
public final @NotNull net.minecraft.network.chat.Component getDisplayName()

Description copied from class: McbsEditorTab

This method provides the display name that will be shown in the user interface for this particular tab within an McbsEditor.

Specified by:

getDisplayName in class McbsEditorTab

getMcbsFile

@UnstableApi
@NotNull
public final @NotNull McbsFile getMcbsFile()

Returns the raw unfiltered McbsFile instance this MVC controller controls.

It is generally recommended not to manually write data in there such that it bypasses this controller. Use this for read-only operations only.

If you really must write, call McbsEditorTab.addEditCount() afterward.

getStats

@NotNull
public final @NotNull com.thecsdev.commonmc.api.stats.IStatsProvider getStats()

Returns an IStatsProvider view of the McbsStats instance this McbsEditorFileTab is managing.

Important API note:
Intended to be read-only! Attempts to set stat values may and will throw!

getGoals

@NotNull
public final @NotNull Map<net.minecraft.resources.Identifier, McbsGoal> getGoals()

Returns a Map view of the McbsGoal instances this McbsEditorFileTab is managing.

Important API note:
Intended to be read-only! Attempts to modify the map (e.g. adding/removing goals) will throw!

getCurrentView

@NotNull
public final @NotNull StatsView getCurrentView()

Returns the StatsView instance that is currently selected for this McbsEditorFileTab.

setCurrentView

public final void setCurrentView(@NotNull
 @NotNull StatsView view)
                          throws NullPointerException

Sets the StatsView instance that is currently selected for this McbsEditorFileTab.

Parameters:

view - The StatsView to be set as current.

Throws:

NullPointerException - If an argument is null.

getStatFilters

@NotNull
public final StatsView.Filters getStatFilters()

Returns the StatsView.Filters instance that is used for this McbsEditorFileTab. These filters tell StatsViews which stats are to be shown on screen.

putGoal

public final void putGoal(@NotNull
 @NotNull McbsGoal goal)
                   throws NullPointerException

Puts an McbsGoal into McbsFile.getGoals().

Parameters:

goal - The McbsGoal to add.

Throws:

NullPointerException - If the argument is null.

putGoal

public final void putGoal(@NotNull
 @NotNull net.minecraft.resources.Identifier id,
 @NotNull
 @NotNull McbsGoal goal)
                   throws NullPointerException

Puts an McbsGoal into McbsFile.getGoals() with a specific Identifier key.

Parameters:

id - The Identifier key to associate with the goal.

goal - The McbsGoal to add.

Throws:

NullPointerException - If an argument is null.

removeGoal

public final boolean removeGoal(@NotNull
 @NotNull McbsGoal goal)
                         throws NullPointerException

Removes an McbsGoal from the McbsFile.

Parameters:

goal - The McbsGoal to remove.

Returns:

true if the goal was removed, or false if the McbsFile did not contain the specified goal.

Throws:

NullPointerException - If the argument is null.

removeGoal

public final boolean removeGoal(@NotNull
 @NotNull net.minecraft.resources.Identifier id)
                         throws NullPointerException

Removes an McbsGoal from the McbsFile.

Parameters:

id - The Identifier key of the McbsGoal to remove.

Returns:

true if the goal was removed, or false if the McbsFile did not contain a goal with the specified id.

Throws:

NullPointerException - If the argument is null.

saveAs

public final void saveAs(@NotNull
 @NotNull Path file)
                  throws NullPointerException,
IllegalArgumentException,
IOException

Saves the McbsFile data of this McbsEditorFileTab to the specified file.

Parameters:

file - The file to save the data to.

Throws:

NullPointerException - If the argument is null.

IllegalArgumentException - If the File's extension-name is unsupported.

IOException - If an I/O error occurs during File writing.

API Note:

Supports .json and .nbt Files only.

loadFrom

public final void loadFrom(@NotNull
 @NotNull Path file)
                    throws NullPointerException,
IllegalArgumentException,
IOException

Loads the McbsFile data from the specified file into this McbsEditorFileTab's McbsFile instance.

This overrides existing McbsFile data!

Parameters:

file - The file to load the data from.

Throws:

NullPointerException - If an argument is null.

IllegalArgumentException - If the File's extension-name is unsupported.

IOException - If an I/O error occurs during File reading.

API Note:

Supports .json and .nbt Files only.

loadStatsFrom

public final void loadStatsFrom(@NotNull
 @NotNull com.thecsdev.commonmc.api.stats.IStatsProvider statsProvider)
                         throws NullPointerException

Loads the McbsStats data from the specified IStatsProvider into this McbsEditorFileTab's McbsFile instance.

Specifically, calls McbsStats.clearAndAddAll(IStatsProvider).

This overrides existing McbsStats data!

Parameters:

statsProvider - The IStatsProvider to load the data from.

Throws:

NullPointerException - If an argument is null.