Index (Yildiz-Engine Common Application 1.4.16 API)

A B C D E F G I L N P R S T U W
All Classes and Interfaces|All Packages

A

addBannerLine(BannerLine) - Method in class be.yildizgames.common.application.Application: Add a line to the banner.
addLine(BannerLine) - Method in class be.yildizgames.common.application.helper.cli.Banner: Adds a line of text to the banner.
Application - Class in be.yildizgames.common.application: Main application class.
ApplicationRestarter - Class in be.yildizgames.common.application.helper.restarter: Handles restarting the application java process.
ApplicationRestarter(String) - Constructor for class be.yildizgames.common.application.helper.restarter.ApplicationRestarter: Creates a new restarter with the given JAR name.
ApplicationRestarter(String, String) - Constructor for class be.yildizgames.common.application.helper.restarter.ApplicationRestarter: Creates a new restarter with the given JAR name and a provided.
applicationStarted() - Method in class be.yildizgames.common.application.Application: To call once the application is started, this will close the splashscreen.
AvailabilityChecker - Interface in be.yildizgames.common.application.helper.network: Defines a contract for checking the availability of a network resource.

B

Banner - Class in be.yildizgames.common.application.helper.cli: A banner to display at the startup of the application in the terminal.
Banner(String) - Constructor for class be.yildizgames.common.application.helper.cli.Banner: Creates a new banner with the given application name.
BannerLine - Interface in be.yildizgames.common.application.helper.cli: Represents an additional line that can be added to a banner.
be.yildizgames.common.application - module be.yildizgames.common.application: Modules for the common application.
be.yildizgames.common.application - package be.yildizgames.common.application
be.yildizgames.common.application.helper.cli - package be.yildizgames.common.application.helper.cli
be.yildizgames.common.application.helper.network - package be.yildizgames.common.application.helper.network
be.yildizgames.common.application.helper.restarter - package be.yildizgames.common.application.helper.restarter
be.yildizgames.common.application.helper.splashscreen - package be.yildizgames.common.application.helper.splashscreen
be.yildizgames.common.application.helper.updater - package be.yildizgames.common.application.helper.updater
buildSplashScreen(Properties) - Method in interface be.yildizgames.common.application.helper.splashscreen.SplashScreenProvider: Builds a splash screen implementation using the given properties.

C

close() - Method in class be.yildizgames.common.application.helper.splashscreen.EmptySplashScreen
close() - Method in interface be.yildizgames.common.application.helper.splashscreen.SplashScreen: Closes the splash screen.
completed() - Method in class be.yildizgames.common.application.helper.splashscreen.UpdateSplashScreen
completed() - Method in interface be.yildizgames.common.application.helper.updater.UpdateDownloadListener: Called when the entire download completes.

D

display() - Method in class be.yildizgames.common.application.helper.cli.Banner: Displays the banner in the terminal.
display() - Method in class be.yildizgames.common.application.helper.splashscreen.EmptySplashScreen
display() - Method in interface be.yildizgames.common.application.helper.splashscreen.SplashScreen: Displays the splash screen.
displayTimeElapsed(String) - Method in class be.yildizgames.common.application.helper.cli.PerformanceChecker: Displays the elapsed time since construction or the last call in milliseconds.
downloadCompletedSuccessfully() - Method in interface be.yildizgames.common.application.helper.updater.UpdateDownloadListener: Called when the entire download completes successfully.
downloadUpdated(int) - Method in class be.yildizgames.common.application.helper.splashscreen.UpdateSplashScreen
downloadUpdated(int) - Method in interface be.yildizgames.common.application.helper.updater.UpdateDownloadListener: Called when the overall download percentage is updated.

E

EmptySplashScreen - Class in be.yildizgames.common.application.helper.splashscreen: A splash screen implementation that does nothing.
EmptySplashScreen() - Constructor for class be.yildizgames.common.application.helper.splashscreen.EmptySplashScreen: Creates a new empty splash screen.

F

fileCompletedSuccessfully(Path) - Method in interface be.yildizgames.common.application.helper.updater.UpdateDownloadListener: Called when a file download completes successfully.
fileUpdated(Path, int) - Method in class be.yildizgames.common.application.helper.splashscreen.UpdateSplashScreen
fileUpdated(Path, int) - Method in interface be.yildizgames.common.application.helper.updater.UpdateDownloadListener: Called when the file download percentage is updated.
fileUpToDate() - Method in interface be.yildizgames.common.application.helper.updater.UpdateDownloadListener: Called when a file is determined to already be up to date.
fromFile(Path) - Method in class be.yildizgames.common.application.helper.cli.Banner: Loads lines of text from the given file path.

G

getApplicationName() - Method in class be.yildizgames.common.application.UpdatableEntryPoint: Provide the name of the application.
getApplicationProperties() - Method in class be.yildizgames.common.application.Starter: Gets the application configuration properties.
getConfiguration() - Method in class be.yildizgames.common.application.Application: Get the application configuration.
getDefaultConfiguration() - Method in class be.yildizgames.common.application.UpdatableEntryPoint: Provide the default configuration properties.
getPreferredAddress() - Static method in class be.yildizgames.common.application.helper.network.NetworkInterface: Provide the IP address.
getServerUrl() - Method in interface be.yildizgames.common.application.helper.network.ServerAccessConfiguration: Gets the URL of the server.
getSplashScreen() - Method in class be.yildizgames.common.application.UpdatableEntryPoint: Provide the splash screen.
getStarter() - Method in class be.yildizgames.common.application.UpdatableEntryPoint: Provide the starter.
getUpdateUrl() - Method in class be.yildizgames.common.application.UpdatableEntryPoint: Provide the url to call to get the update manifest.

I

isChecking() - Method in class be.yildizgames.common.application.helper.network.SocketAvailabilityChecker: Checks if the availability status is currently checking.
isOffLine() - Method in class be.yildizgames.common.application.helper.network.SocketAvailabilityChecker: Checks if the target resource is currently reported as offline.
isOnline() - Method in interface be.yildizgames.common.application.helper.network.AvailabilityChecker: Checks if the target resource is available online.
isOnline() - Method in class be.yildizgames.common.application.helper.network.SocketAvailabilityChecker

L

launch(String[]) - Method in class be.yildizgames.common.application.UpdatableEntryPoint: Launches the application by initializing common components.
LauncherRestarter - Class in be.yildizgames.common.application.helper.restarter: Handles restarting the application process by using a native launcher.
LauncherRestarter(String, String) - Constructor for class be.yildizgames.common.application.helper.restarter.LauncherRestarter: Constructs a Restarter with the executables.

N

NetworkInterface - Class in be.yildizgames.common.application.helper.network: Provide the IP address of the machine on the local network.

P

PerformanceChecker - Class in be.yildizgames.common.application.helper.cli: Utility class for measuring and displaying elapsed time between operations.
PerformanceChecker() - Constructor for class be.yildizgames.common.application.helper.cli.PerformanceChecker: Creates a new PerformanceChecker instance.
prepare(String) - Static method in class be.yildizgames.common.application.Application: Prepare to start the application.
print() - Method in interface be.yildizgames.common.application.helper.cli.BannerLine: Prints this banner line as a string.
println(String) - Static method in class be.yildizgames.common.application.helper.cli.Terminal: Print the message in a line.

R

restart() - Method in class be.yildizgames.common.application.helper.restarter.ApplicationRestarter
restart() - Method in class be.yildizgames.common.application.helper.restarter.LauncherRestarter
restart() - Method in interface be.yildizgames.common.application.helper.restarter.Restarter: Restarts the application process immediately.
restart(long) - Method in class be.yildizgames.common.application.helper.restarter.ApplicationRestarter
restart(long) - Method in class be.yildizgames.common.application.helper.restarter.LauncherRestarter
restart(long) - Method in interface be.yildizgames.common.application.helper.restarter.Restarter: Restarts the application process after a delay.
Restarter - Interface in be.yildizgames.common.application.helper.restarter: Handles restarting the application.
run(LaunchContext) - Method in class be.yildizgames.common.application.UpdatableEntryPoint

S

ServerAccessConfiguration - Interface in be.yildizgames.common.application.helper.network: Defines a configuration for accessing a server.
setCurrentLoading(String) - Method in class be.yildizgames.common.application.helper.splashscreen.EmptySplashScreen
setCurrentLoading(String) - Method in interface be.yildizgames.common.application.helper.splashscreen.SplashScreen: Sets the current loading task name to display.
setName(String) - Method in class be.yildizgames.common.application.helper.splashscreen.EmptySplashScreen
setName(String) - Method in interface be.yildizgames.common.application.helper.splashscreen.SplashScreen: Sets the name to display on the splash screen.
setProgress(int) - Method in class be.yildizgames.common.application.helper.splashscreen.EmptySplashScreen
setProgress(int) - Method in interface be.yildizgames.common.application.helper.splashscreen.SplashScreen: Sets the loading progress percentage to display.
SocketAvailabilityChecker - Class in be.yildizgames.common.application.helper.network: Checks the availability of a network resource using socket connections.
SocketAvailabilityChecker(ServerAccessConfiguration) - Constructor for class be.yildizgames.common.application.helper.network.SocketAvailabilityChecker: Creates a new checker with the given server configuration.
SplashScreen - Interface in be.yildizgames.common.application.helper.splashscreen: Defines a splash screen that can be displayed during application launch.
SplashScreenProvider - Interface in be.yildizgames.common.application.helper.splashscreen: Provides implementations of splash screens.
start() - Method in class be.yildizgames.common.application.Application: Initialize and start the application.
start() - Method in class be.yildizgames.common.application.Starter: Starts the application.
start(Starter) - Method in class be.yildizgames.common.application.Application: Initialize and start the application by using a starter.
startDownloadFile(Path) - Method in class be.yildizgames.common.application.helper.splashscreen.UpdateSplashScreen
startDownloadFile(Path) - Method in interface be.yildizgames.common.application.helper.updater.UpdateDownloadListener: Called when a file download is started.
startDownloads() - Method in interface be.yildizgames.common.application.helper.updater.UpdateDownloadListener: Called when downloads are started.
Starter - Class in be.yildizgames.common.application: Base class for application starters.
Starter() - Constructor for class be.yildizgames.common.application.Starter: Creates a new starter.

T

Terminal - Class in be.yildizgames.common.application.helper.cli: Simple class to display messages in the console

U

UpdatableEntryPoint - Class in be.yildizgames.common.application: Base class for application entry points that support updating.
UpdatableEntryPoint() - Constructor for class be.yildizgames.common.application.UpdatableEntryPoint: Creates a new entry point.
update(String, String, TemporalAmount, int, List<UpdateDownloadListener>) - Method in class be.yildizgames.common.application.helper.updater.UpdateHelper: Checks for and applies any available updates.
UpdateDownloadListener - Interface in be.yildizgames.common.application.helper.updater: Listener for download update events.
UpdateHelper - Class in be.yildizgames.common.application.helper.updater: Handles checking for and applying updates.
UpdateHelper() - Constructor for class be.yildizgames.common.application.helper.updater.UpdateHelper: Creates a new update helper.
UpdateSplashScreen - Class in be.yildizgames.common.application.helper.splashscreen: Base splash screen implementation that supports updating progress.
UpdateSplashScreen() - Constructor for class be.yildizgames.common.application.helper.splashscreen.UpdateSplashScreen: Creates a new update splash screen.

W

withBanner(Banner) - Method in class be.yildizgames.common.application.Application: To set a custom banner, the banner will be displayed in the console interface when starting the application.
withConfiguration(String[], Properties) - Method in class be.yildizgames.common.application.Application: Add configuration to the application.
withConfiguration(String[], Properties, ConfigurationNotFoundAdditionalBehavior) - Method in class be.yildizgames.common.application.Application: Add configuration to the application.
withSplashScreen(SplashScreenProvider) - Method in class be.yildizgames.common.application.Application: Set a splash screen to display when starting the application.
withUpdate(String) - Method in class be.yildizgames.common.application.Application: Provide the update mechanism.
withUpdate(String, int) - Method in class be.yildizgames.common.application.Application: Provide the update mechanism.

A B C D E F G I L N P R S T U W
All Classes and Interfaces|All Packages