Interface EngineConfig

All Known Implementing Classes:
EngineConfigAdapter
public interface EngineConfig
Configuration for the Engine, which declares basic principles for its application setup.
Author:
Matthew Tropiano

  • Method Details

    • getApplicationName

      String getApplicationName()
      Returns:
      the application name. Can be null.

    • getApplicationVersion

      String getApplicationVersion()
      Returns:
      the application version string. Can be null.

    • getApplicationIcon

      Image getApplicationIcon()
      Returns:
      the icon used for the application. Can be null.

    • getApplicationSupportEmail

      String getApplicationSupportEmail()
      Returns:
      the e-mail address used for support. Can be null.

    • getApplicationContactEmail

      String getApplicationContactEmail()
      Returns:
      the e-mail address used for general contact. Can be null.

    • getApplicationHomepage

      String getApplicationHomepage()
      Returns:
      the URL for the application homepage. Can be null.

    • getApplicationSupportPage

      String getApplicationSupportPage()
      Returns:
      the e-mail address used for general contact. Can be null.

    • getPackageRoots

      String[] getPackageRoots()
      Returns:
      the package root name for scanning stuff in the engine application classpath.

    • getStartupComponentClasses

      String[] getStartupComponentClasses()
      Gets the list of singleton classes that should be instantiated on startup. Their dependencies are also loaded. All names do not need full qualification. If null, all classes are loaded.
      Returns:
      an array of singleton classes to load.

    • getGlobalSettingsPath

      String getGlobalSettingsPath()
      Returns the directory path for storing global configuration. NOTE: This is OUTSIDE of the file system path.
      Returns:
      the global settings path root.

    • getUserSettingsPath

      String getUserSettingsPath()
      Returns the directory path for storing user configuration. NOTE: This is OUTSIDE of the file system path.
      Returns:
      the user settings path root.

    • getGlobalVariablesFile

      String getGlobalVariablesFile()
      Returns the file off of the global directory path for storing/reading archived variables. If null, saves/reads nothing.
      Returns:
      the filename to store global variables in.
      See Also:

    • getUserVariablesFile

      String getUserVariablesFile()
      Returns the file off of the user directory path for storing/reading archived variables. If null, saves/reads nothing.
      Returns:
      the filename to store user variables in.
      See Also:

    • getLogFile

      String getLogFile()
      Returns the file to log console output to (other than the console itself). NOTE: This is OUTSIDE of the file system path.
      Returns:
      the filename of the log.

    • getLogLevel

      EngineLoggingFactory.LogLevel getLogLevel()
      Returns:
      the base logging level for the logging factory.

    • getFileSystemStack

      String[] getFileSystemStack()
      Gets the list of directory paths to add in lowest to greatest stack precedence. If empty, these directories are not added. This is consulted if getFileSystemArchives() returns an empty value.
      Returns:
      the paths to push onto the filesystem stack.
      See Also:

    • getFileSystemArchives

      String[] getFileSystemArchives()
      Gets the file system archives to mount. Files are considered to be ZIP formatted. If null, does not load specific archive types. Archives are loaded in order specified in the array. NOTE: If this is not empty, loading via FileSystemStack is ignored.
      Returns:
      the array of archive paths off of the mounted filesystem.
      See Also:

    • getFileSystemStackArchiveAutoloadExtension

      String getFileSystemStackArchiveAutoloadExtension()
      Gets the file system extension for archive types to mount. Files are considered to be ZIP formatted. If empty, does not auto-load archive types. Archives are loaded in lexicographical order.
      Returns:
      the archive file extension or null to not auto-load archives.
      See Also:

    • getUpdatesPerSecond

      Integer getUpdatesPerSecond()
      Gets how many updates per second that the main updating thread needs to do. If the returned value is 0 or less, this runs full bore. If this returns null the updater is not started.
      Returns:
      the updates per second of the main ticker.

    • getDebugMode

      boolean getDebugMode()
      Returns:
      if this Engine should start in debug mode.

    • getConsoleCommandsToExecute

      String[] getConsoleCommandsToExecute()
      Gets the list of console commands to execute after startup. If empty, nothing happens.
      Returns:
      a list of console commands to execute after startup.