de.griefed.serverpackcreator

Class ApplicationProperties

java.lang.Object

java.util.Dictionary<K,V>

java.util.Hashtable<java.lang.Object,java.lang.Object>

java.util.Properties

de.griefed.serverpackcreator.ApplicationProperties

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.Object,java.lang.Object>

@Component
public class ApplicationProperties
extends java.util.Properties

Our properties-class. Extends Properties. Sets up default properties loaded from the local serverpackcreator.properties and allows reloading of said properties if the file has changed.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
java.io.File	FILE_CONFIG
java.io.File	FILE_CONFIG_OLD
java.io.File	FILE_FORGE_ONE_SEVEN_USER_JVM_ARGS
java.io.File	FILE_LINUX
java.io.File	FILE_MANIFEST_FABRIC
java.io.File	FILE_MANIFEST_FABRIC_INSTALLER
java.io.File	FILE_MANIFEST_FORGE
java.io.File	FILE_MANIFEST_MINECRAFT
java.io.File	FILE_SERVER_ICON
java.io.File	FILE_SERVER_PROPERTIES
java.io.File	FILE_SERVERPACKCREATOR_DATABASE
java.io.File	FILE_SERVERPACKCREATOR_PROPERTIES
java.io.File	FILE_WINDOWS
java.util.List<java.lang.String>	LIST_FALLBACK_MODS_DEFAULT
java.io.File	PATH_FILE_MANIFEST_FABRIC
java.io.File	PATH_FILE_MANIFEST_FABRIC_INSTALLER
java.io.File	PATH_FILE_MANIFEST_FORGE
java.io.File	PATH_FILE_MANIFEST_MINECRAFT

Fields inherited from class java.util.Properties

defaults

Constructor Summary

Constructors

Constructor and Description
ApplicationProperties() Constructor for our properties.

Method Summary

Modifier and Type	Method and Description
void	addToListOfDirectoriesToExclude(java.lang.String entry) Adder for the list of directories to exclude from server packs.
boolean	checkForAvailablePreReleases() Getter for whether the search for available PreReleases is enabled or disabled. Depending on de.griefed.serverpackcreator.versioncheck.prerelease, returns true if checks for available PreReleases are enabled, false if no checks for available PreReleases should be made.
boolean	getCurseControllerRegenerationEnabled() Getter for whether the regeneration of server packs is enabled.
java.lang.String	getDirectoryServerPacks() Getter for the directory in which the server packs are stored/generated in.
java.util.List<java.lang.String>	getListFallbackMods() Getter for the fallback list of clientside-only mods.
java.util.List<java.lang.String>	getListOfDirectoriesToExclude() Getter for the list of directories to exclude from server packs.
int	getQueueMaxDiskUsage() Getter for the maximum disk usage at which JMS/Artemis will stop storing queues on disk.
boolean	getSaveLoadedConfiguration() Getter for whether the last loaded configuration file should be saved to as well.
java.lang.String	getServerPackCreatorVersion() Getter for the version of ServerPackCreator. If a JAR-file compiled from a release-job from a CI/CD-pipeline is used, it should contain a VERSION.txt-file which contains the version of said release.
boolean	isCurseForgeActivated() Getter for whether the CurseForge API in ServerPackCreator is activated.
ApplicationProperties	reload() Reload serverpackcreator.properties.
java.lang.String	toString()
boolean	updateFallback() Update the fallback clientside-only modlist of our serverpackcreator.properties from the main-repository or one of its mirrors.

Methods inherited from class java.util.Properties

getProperty, getProperty, list, list, load, load, loadFromXML, propertyNames, save, setProperty, store, store, storeToXML, storeToXML, stringPropertyNames

Methods inherited from class java.util.Hashtable

clear, clone, compute, computeIfAbsent, computeIfPresent, contains, containsKey, containsValue, elements, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keys, keySet, merge, put, putAll, putIfAbsent, rehash, remove, remove, replace, replace, replaceAll, size, values

Methods inherited from class java.lang.Object

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

Field Detail

FILE_SERVERPACKCREATOR_PROPERTIES

public final java.io.File FILE_SERVERPACKCREATOR_PROPERTIES

FILE_WINDOWS

public final java.io.File FILE_WINDOWS

FILE_LINUX

public final java.io.File FILE_LINUX

FILE_FORGE_ONE_SEVEN_USER_JVM_ARGS

public final java.io.File FILE_FORGE_ONE_SEVEN_USER_JVM_ARGS

LIST_FALLBACK_MODS_DEFAULT

public final java.util.List<java.lang.String> LIST_FALLBACK_MODS_DEFAULT

FILE_CONFIG

public final java.io.File FILE_CONFIG

FILE_CONFIG_OLD

public final java.io.File FILE_CONFIG_OLD

FILE_SERVER_PROPERTIES

public final java.io.File FILE_SERVER_PROPERTIES

FILE_SERVER_ICON

public final java.io.File FILE_SERVER_ICON

FILE_MANIFEST_MINECRAFT

public final java.io.File FILE_MANIFEST_MINECRAFT

FILE_MANIFEST_FORGE

public final java.io.File FILE_MANIFEST_FORGE

FILE_MANIFEST_FABRIC

public final java.io.File FILE_MANIFEST_FABRIC

FILE_MANIFEST_FABRIC_INSTALLER

public final java.io.File FILE_MANIFEST_FABRIC_INSTALLER

FILE_SERVERPACKCREATOR_DATABASE

public final java.io.File FILE_SERVERPACKCREATOR_DATABASE

PATH_FILE_MANIFEST_MINECRAFT

public final java.io.File PATH_FILE_MANIFEST_MINECRAFT

PATH_FILE_MANIFEST_FORGE

public final java.io.File PATH_FILE_MANIFEST_FORGE

PATH_FILE_MANIFEST_FABRIC

public final java.io.File PATH_FILE_MANIFEST_FABRIC

PATH_FILE_MANIFEST_FABRIC_INSTALLER

public final java.io.File PATH_FILE_MANIFEST_FABRIC_INSTALLER

Constructor Detail

ApplicationProperties

@Autowired
public ApplicationProperties()

Constructor for our properties. Sets a couple of default values for use in ServerPackCreator.

Method Detail

reload

public ApplicationProperties reload()

Reload serverpackcreator.properties.

Returns:

ApplicationProperties The updated instance of this object.

getDirectoryServerPacks

public java.lang.String getDirectoryServerPacks()

Getter for the directory in which the server packs are stored/generated in.

Returns:

String. Returns the directory in which the server packs are stored/generated in.

getListFallbackMods

public java.util.List<java.lang.String> getListFallbackMods()

Getter for the fallback list of clientside-only mods.

Returns:

List String. Returns the fallback list of clientside-only mods.

getListOfDirectoriesToExclude

public java.util.List<java.lang.String> getListOfDirectoriesToExclude()

Getter for the list of directories to exclude from server packs.

Returns:

List String. Returns the list of directories to exclude from server packs.

addToListOfDirectoriesToExclude

public void addToListOfDirectoriesToExclude(java.lang.String entry)

Adder for the list of directories to exclude from server packs.

Parameters:

entry - String. The directory to add to the list of directories to exclude from server packs.

getCurseControllerRegenerationEnabled

public boolean getCurseControllerRegenerationEnabled()

Getter for whether the regeneration of server packs is enabled.

Returns:

Boolean. Whether the regeneration of server packs is enabled.

getSaveLoadedConfiguration

public boolean getSaveLoadedConfiguration()

Getter for whether the last loaded configuration file should be saved to as well.

Returns:

Boolean. Whether the last loaded configuration file should be saved to as well.

getQueueMaxDiskUsage

public int getQueueMaxDiskUsage()

Getter for the maximum disk usage at which JMS/Artemis will stop storing queues on disk.

Returns:

Integer. The maximum disk usage at which JMS/Artemis will stop storing queues on disk.

getServerPackCreatorVersion

public java.lang.String getServerPackCreatorVersion()

Getter for the version of ServerPackCreator.
If a JAR-file compiled from a release-job from a CI/CD-pipeline is used, it should contain a VERSION.txt-file which contains the version of said release. If a non-release-version is used, from a regular pipeline or local dev-build, then this will be set to dev.

Returns:

String. Returns the version of ServerPackCreator.

checkForAvailablePreReleases

public boolean checkForAvailablePreReleases()

Getter for whether the search for available PreReleases is enabled or disabled.
Depending on de.griefed.serverpackcreator.versioncheck.prerelease, returns true if checks for available PreReleases are enabled, false if no checks for available PreReleases should be made.

Returns:

Boolean. Whether checks for available PreReleases are enabled.

isCurseForgeActivated

public boolean isCurseForgeActivated()

Getter for whether the CurseForge API in ServerPackCreator is activated. In order for the CurseForge API to be activated, you need to set the property de.griefed.serverpackcreator.curseforge.api.token with a valid CurseAPI token in the serverpackcreator.properties-file.

Returns:

Boolean. Whether the CurseForge API in ServerPackCreator is activated.

updateFallback

public boolean updateFallback()

Update the fallback clientside-only modlist of our serverpackcreator.properties from the main-repository or one of its mirrors.

Returns:

true if the fallback-property was updated.

toString

public java.lang.String toString()

Overrides:

toString in class java.util.Hashtable<java.lang.Object,java.lang.Object>