com.xatkit

Class Xatkit

java.lang.Object

com.xatkit.Xatkit

public class Xatkit
extends Object

The main Xatkit Class used to start a Xatkit bot instance.

This class is executed when invoking java -jar xatkit.jar. The main(String[]) method accepts an optional String argument containing the path of the .properties file to use to start Xatkit. If Xatkit is started without a .properties file it will try to load its properties from the System.getenv() map.

See Also:

main(String[])

Constructor Summary

Constructors

Constructor and Description
Xatkit()

Method Summary

Modifier and Type	Method and Description
static Configuration	getConfiguration() Returns the Configuration used to initialize the XatkitCore instance.
static XatkitCore	getXatkitCore() Returns the XatkitCore instance used to run the bot.
static void	main(String[] args) Starts the underlying XatkitCore engine.

Methods inherited from class java.lang.Object

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

Constructor Detail

Xatkit

public Xatkit()

Method Detail

main

public static void main(String[] args)

Starts the underlying XatkitCore engine.

The provided args can contain a single value representing the path of the .properties file to use to start Xatkit. If Xatkit is started without a .properties file it will try to load its properties from the System.getenv() map. In this case the property keys must be upper cased, and . must be replaced by _. See the documentation for more information.

Parameters:

args - the program's arguments

getConfiguration

public static Configuration getConfiguration()

Returns the Configuration used to initialize the XatkitCore instance.

This method is used for testing purposes, and allows to check the loaded Configuration even if the XatkitCore initialization fails.

Returns:

the Configuration used to initialize the XatkitCore instance.

getXatkitCore

public static XatkitCore getXatkitCore()

Returns the XatkitCore instance used to run the bot.

Returns:

the XatkitCore instance used to run the bot