Package de.craftsblock.craftsnet.builder

Class AddonContainingBuilder

java.lang.Object

de.craftsblock.craftsnet.builder.CraftsNetBuilder

de.craftsblock.craftsnet.builder.AddonContainingBuilder

public class AddonContainingBuilder
extends CraftsNetBuilder

Builder class for configuring the CraftsNet with a set of addons.

Since:

3.1.0-SNAPSHOT

See Also:

• CraftsNetBuilder

Constructor Summary

Constructors

Constructor	Description
AddonContainingBuilder(Collection<Class<? extends Addon>> addons)	Creates a new instance of AddonContainingBuilder with providing a collection containing Addon classes.

Method Summary

Modifier and Type	Method	Description
AddonContainingBuilder	addCodeSource(CodeSource codeSource)	Adds a CodeSource to the code sources list.
CraftsNet	build()	Builds and starts the CraftsNet framework with the configured settings.
Collection<Class<? extends Addon>>	getAddons()	Gets all the currently registered Addon classes which should be loaded.
void	loadAddons(CraftsNet craftsNet)	Load all the addons that have been registered in the builder.
AddonContainingBuilder	map(Class<? extends Addon> type, String name)	Maps an addon class to a custom name.
AddonContainingBuilder	removeCodeSource(CodeSource codeSource)	Removes a CodeSource from the code sources list.
AddonContainingBuilder	withAddonSystem(ActivateType type)	Specifies the activation type for the addon system.
AddonContainingBuilder	withApplyResponseEncoding(boolean allowed)	Specifies whether from the client requested response encodings should be applied or not.
AddonContainingBuilder	withArgs(String[] args)	Configures the builder using a set of command-line arguments.
AddonContainingBuilder	withCommandSystem(ActivateType type)	Specifies the activation type for the command system.
AddonContainingBuilder	withCustomLogger(Logger logger)	Sets a custom logger which will be used by CraftsNet.
AddonContainingBuilder	withDebug(boolean enabled)	Specifies whether debug mode should be enabled.
AddonContainingBuilder	withFileLogger(ActivateType type)	Specifies the activation type for the file logger.
AddonContainingBuilder	withIpsInLog(boolean enabled)	Specifies whether ips should be blurred in the log output.
AddonContainingBuilder	withLogger(ActivateType type)	Specifies the activation type for the logger.
AddonContainingBuilder	withLogRotate(@org.jetbrains.annotations.Range(from=0L, to=9223372036854775807L) long logRotate)	Sets the log rotation size threshold for this builder.
AddonContainingBuilder	withoutLogRotate()	Disables log rotation by setting the log rotation size threshold to 0.
AddonContainingBuilder	withSessionCache(int size)	Specifies the size of the session cache.
AddonContainingBuilder	withSkipDefaultRoute(boolean skip)	Specifies whether the registration of the default route (if no other route was registered) should be skipped on startup.
AddonContainingBuilder	withSkipVersionCheck(boolean skip)	Specifies whether the version check should be skipped on startup.
AddonContainingBuilder	withSSL(boolean enabled)	Specifies whether SSL should be enabled.
AddonContainingBuilder	withTempFilesOnNormalFileSystem(boolean tempFilesOnNormalFileSystem)	Configures whether temporary files should be placed on the normal file system.
AddonContainingBuilder	withWebServer(int port)	Specifies the port for the web server.
AddonContainingBuilder	withWebServer(ActivateType type)	Specifies the port for the web server.
AddonContainingBuilder	withWebServer(ActivateType type, int port)	Specifies the activation type and port for the web server.
AddonContainingBuilder	withWebSocketServer(int port)	Specifies the port for the WebSocket server.
AddonContainingBuilder	withWebSocketServer(ActivateType type)	Specifies the activation type and port for the WebSocket server.
AddonContainingBuilder	withWebSocketServer(ActivateType type, int port)	Specifies the activation type and port for the WebSocket server.

Methods inherited from class de.craftsblock.craftsnet.builder.CraftsNetBuilder

getAddonSystem, getCodeSources, getCommandSystem, getCustomLogger, getLogRotate, getSessionCacheSize, getWebServer, getWebServerPort, getWebSocketServer, getWebSocketServerPort, isAddonSystem, isCommandSystem, isDebug, isFileLogger, isLogRotate, isSSL, isWebServer, isWebSocketServer, responseEncodingAllowed, setArg, shouldHideIps, shouldPlaceTempFilesOnNormalFileSystem, shouldSkipDefaultRoute, shouldSkipVersionCheck

Methods inherited from class java.lang.Object

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

Constructor Details

AddonContainingBuilder

public AddonContainingBuilder(Collection<Class<? extends Addon>> addons)

Creates a new instance of AddonContainingBuilder with providing a collection containing Addon classes.

Parameters:

addons - A collection containing all Addon classes which should be loaded.

Method Details

map

public AddonContainingBuilder map(Class<? extends Addon> type,
 String name)

Maps an addon class to a custom name.

Parameters:

type - The addon class.

name - The name to associate with the addon class.

Returns:

The AddonContainingBuilder instance.

withArgs

public AddonContainingBuilder withArgs(String[] args)

Configures the builder using a set of command-line arguments.

Parses the provided arguments and applies corresponding settings to the builder. If a specific argument is not recognized, an exception is thrown.

Overrides:

withArgs in class CraftsNetBuilder

Parameters:

args - An array of command-line arguments to parse.

Returns:

The current instance of CraftsNetBuilder for chaining.

addCodeSource

public AddonContainingBuilder addCodeSource(CodeSource codeSource)

Adds a CodeSource to the code sources list.

Overrides:

addCodeSource in class CraftsNetBuilder

Parameters:

codeSource - The CodeSource that should be added.

Returns:

The CraftsNetBuilder instance.

removeCodeSource

public AddonContainingBuilder removeCodeSource(CodeSource codeSource)

Removes a CodeSource from the code sources list.

Overrides:

removeCodeSource in class CraftsNetBuilder

Parameters:

codeSource - The CodeSource that should be removed.

Returns:

The CraftsNetBuilder instance.

withWebServer

public AddonContainingBuilder withWebServer(int port)

Specifies the port for the web server.

Overrides:

withWebServer in class CraftsNetBuilder

Parameters:

port - The port number for the web server.

Returns:

The CraftsNetBuilder instance.

withWebServer

public AddonContainingBuilder withWebServer(ActivateType type)

Specifies the port for the web server.

Overrides:

withWebServer in class CraftsNetBuilder

Parameters:

type - The activation type for the web server.

Returns:

The CraftsNetBuilder instance.

withWebServer

public AddonContainingBuilder withWebServer(ActivateType type,
 int port)

Specifies the activation type and port for the web server.

Overrides:

withWebServer in class CraftsNetBuilder

Parameters:

type - The activation type for the web server.

port - The port number for the web server.

Returns:

The CraftsNetBuilder instance.

withWebSocketServer

public AddonContainingBuilder withWebSocketServer(int port)

Specifies the port for the WebSocket server.

Overrides:

withWebSocketServer in class CraftsNetBuilder

Parameters:

port - The port number for the WebSocket server.

Returns:

The CraftsNetBuilder instance.

withWebSocketServer

public AddonContainingBuilder withWebSocketServer(ActivateType type)

Specifies the activation type and port for the WebSocket server.

Overrides:

withWebSocketServer in class CraftsNetBuilder

Parameters:

type - The activation type for the WebSocket server.

Returns:

The CraftsNetBuilder instance.

withWebSocketServer

public AddonContainingBuilder withWebSocketServer(ActivateType type,
 int port)

Specifies the activation type and port for the WebSocket server.

Overrides:

withWebSocketServer in class CraftsNetBuilder

Parameters:

type - The activation type for the WebSocket server.

port - The port number for the WebSocket server.

Returns:

The CraftsNetBuilder instance.

withAddonSystem

public AddonContainingBuilder withAddonSystem(ActivateType type)

Specifies the activation type for the addon system.

Overrides:

withAddonSystem in class CraftsNetBuilder

Parameters:

type - The activation type for the addon system.

Returns:

The CraftsNetBuilder instance.

withCommandSystem

public AddonContainingBuilder withCommandSystem(ActivateType type)

Specifies the activation type for the command system.

Overrides:

withCommandSystem in class CraftsNetBuilder

Parameters:

type - The activation type for the command system.

Returns:

The CraftsNetBuilder instance.

withSessionCache

public AddonContainingBuilder withSessionCache(int size)

Specifies the size of the session cache.

Overrides:

withSessionCache in class CraftsNetBuilder

Parameters:

size - The size of the session cache.

Returns:

The CraftsNetBuilder instance.

withFileLogger

public AddonContainingBuilder withFileLogger(ActivateType type)

Specifies the activation type for the file logger.

Overrides:

withFileLogger in class CraftsNetBuilder

Parameters:

type - The activation type for the file logger.

Returns:

The CraftsNetBuilder instance.

withApplyResponseEncoding

public AddonContainingBuilder withApplyResponseEncoding(boolean allowed)

Specifies whether from the client requested response encodings should be applied or not.

Overrides:

withApplyResponseEncoding in class CraftsNetBuilder

Parameters:

allowed - true if the requested response encoding should be applied, false otherwise.

Returns:

The CraftsNetBuilder instance.

Since:

3.3.3-SNAPSHOT

withTempFilesOnNormalFileSystem

public AddonContainingBuilder withTempFilesOnNormalFileSystem(boolean tempFilesOnNormalFileSystem)

Configures whether temporary files should be placed on the normal file system. When set to true, the application will store temporary files in the local file system instead of using the system's default temporary file location.

Overrides:

withTempFilesOnNormalFileSystem in class CraftsNetBuilder

Parameters:

tempFilesOnNormalFileSystem - true to place temporary files in the normal file system, false otherwise.

Returns:

the current CraftsNetBuilder instance for method chaining.

withSkipDefaultRoute

public AddonContainingBuilder withSkipDefaultRoute(boolean skip)

Specifies whether the registration of the default route (if no other route was registered) should be skipped on startup.

Overrides:

withSkipDefaultRoute in class CraftsNetBuilder

Parameters:

skip - true if the version check should be skipped, false otherwise.

Returns:

The CraftsNetBuilder instance.

Since:

3.3.3-SNAPSHOT

withSkipVersionCheck

public AddonContainingBuilder withSkipVersionCheck(boolean skip)

Specifies whether the version check should be skipped on startup.

Overrides:

withSkipVersionCheck in class CraftsNetBuilder

Parameters:

skip - true if the version check should be skipped, false otherwise.

Returns:

The CraftsNetBuilder instance.

withCustomLogger

public AddonContainingBuilder withCustomLogger(Logger logger)

Sets a custom logger which will be used by CraftsNet. It can be null when the default logger should be used.

Overrides:

withCustomLogger in class CraftsNetBuilder

Parameters:

logger - The instance of the custom logger.

Returns:

The CraftsNetBuilder instance.

withLogger

public AddonContainingBuilder withLogger(ActivateType type)

Specifies the activation type for the logger.

Overrides:

withLogger in class CraftsNetBuilder

Parameters:

type - The activation type for the logger.

Returns:

The CraftsNetBuilder instance.

withDebug

public AddonContainingBuilder withDebug(boolean enabled)

Specifies whether debug mode should be enabled.

Overrides:

withDebug in class CraftsNetBuilder

Parameters:

enabled - true if debug mode should be enabled, false otherwise.

Returns:

The CraftsNetBuilder instance.

withIpsInLog

public AddonContainingBuilder withIpsInLog(boolean enabled)

Specifies whether ips should be blurred in the log output.

Overrides:

withIpsInLog in class CraftsNetBuilder

Parameters:

enabled - true if ips should be readable in the log, false otherwise.

Returns:

The CraftsNetBuilder instance.

withSSL

public AddonContainingBuilder withSSL(boolean enabled)

Specifies whether SSL should be enabled.

Overrides:

withSSL in class CraftsNetBuilder

Parameters:

enabled - true if SSL should be enabled, false otherwise.

Returns:

The CraftsNetBuilder instance.

withLogRotate

public AddonContainingBuilder withLogRotate(@org.jetbrains.annotations.Range(from=0L, to=9223372036854775807L) long logRotate)

Sets the log rotation size threshold for this builder.

Overrides:

withLogRotate in class CraftsNetBuilder

Parameters:

logRotate - the log rotation size threshold, in bytes. A value of 0 disables log rotation. Must be non-negative.

Returns:

this CraftsNetBuilder instance, enabling method chaining.

withoutLogRotate

public AddonContainingBuilder withoutLogRotate()

Disables log rotation by setting the log rotation size threshold to 0.

Overrides:

withoutLogRotate in class CraftsNetBuilder

Returns:

this CraftsNetBuilder instance, enabling method chaining.

build

public CraftsNet build()
                throws IOException

Builds and starts the CraftsNet framework with the configured settings.

Overrides:

build in class CraftsNetBuilder

Returns:

The constructed CraftsNet instance.

Throws:

IOException - If an I/O error occurs during the startup process.

loadAddons

@Internal
public void loadAddons(CraftsNet craftsNet)

Load all the addons that have been registered in the builder.

Parameters:

craftsNet - The instance of CraftsNet that the addons should be registered on.

getAddons

public Collection<Class<? extends Addon>> getAddons()

Gets all the currently registered Addon classes which should be loaded.

Returns:

A Collection of Addon classes.