Package dev.robocode.tankroyale.botapi

Class BotInfo

java.lang.Object

dev.robocode.tankroyale.botapi.BotInfo

public final class BotInfo
extends Object

Bot info contains the properties of a bot.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	BotInfo.IBuilder	Builder interface for providing a builder for building BotInfo objects, and which supports method chaining.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	MAX_AUTHOR_LENGTH	Maximum number of characters accepted for an author name.
static final int	MAX_DESCRIPTION_LENGTH	Maximum number of characters accepted for the description.
static final int	MAX_GAME_TYPE_LENGTH	Maximum number of characters accepted for a game type.
static final int	MAX_HOMEPAGE_LENGTH	Maximum number of characters accepted for the link to the homepage.
static final int	MAX_NAME_LENGTH	Maximum number of characters accepted for the name.
static final int	MAX_NUMBER_OF_AUTHORS	Maximum number of authors accepted.
static final int	MAX_NUMBER_OF_COUNTRY_CODES	Maximum number of country codes accepted.
static final int	MAX_NUMBER_OF_GAME_TYPES	Maximum number of game types accepted.
static final int	MAX_PLATFORM_LENGTH	Maximum number of characters accepted for the platform name.
static final int	MAX_PROGRAMMING_LANG_LENGTH	Maximum number of characters accepted for the programming language name.
static final int	MAX_VERSION_LENGTH	Maximum number of characters accepted for the version.

Constructor Summary

Constructors

Constructor	Description
BotInfo(String name, String version, List<String> authors, String description, String homepage, List<String> countryCodes, Collection<String> gameTypes, String platform, String programmingLang, InitialPosition initialPosition)	Initializes a new instance of the BotInfo class. Note that the recommended method for creating a BotInfo class is to use the BotInfo.IBuilder interface provided with the static builder() method.

Method Summary

Modifier and Type	Method	Description
static BotInfo.IBuilder	builder()	Returns a builder for a convenient way of building a BotInfo object using the builder pattern. Example of use:
static BotInfo	fromFile(String filename)	Reads the bot info from a local file on a file system. The file is assumed to be in JSON format. See the fromInputStream(java.io.InputStream) to see the required JSON format for the file.
static BotInfo	fromInputStream(InputStream inputStream)	Reads the bot info from an input stream. The file is assumed to be in JSON format. Example file in JSON format:
static BotInfo	fromResourceFile(String filename)	Reads the bot info from a resource file, e.g.
List<String>	getAuthors()	Returns the list of authors of the bot, e.g., "John Doe (johndoe@somewhere.io)".
List<String>	getCountryCodes()	Returns a list of country code(s) defined by ISO 3166-1 alpha-2, e.g.
String	getDescription()	Returns a short description of the bot, preferably a one-liner. This field is optional.
Set<String>	getGameTypes()	Returns the game type(s) accepted by the bot, e.g., "classic", "melee", "1v1".
String	getHomepage()	Returns the URL of a web page for the bot. This field is optional.
InitialPosition	getInitialPosition()	Returns the initial starting position used for debugging only, which must be enabled at the server. This field is optional.
String	getName()	Returns the name, e.g., "MyBot".
String	getPlatform()	Returns the platform used for running the bot, e.g., "Java Runtime Environment (JRE) 11". This field is optional.
String	getProgrammingLang()	Returns the programming language used for developing the bot, e.g., "Java 11" or "Kotlin 1.7.20". This field is optional.
String	getVersion()	Returns the version, e.g., "1.0".

Methods inherited from class java.lang.Object

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

Field Details

MAX_NAME_LENGTH

public static final int MAX_NAME_LENGTH

Maximum number of characters accepted for the name.

See Also:

• Constant Field Values

MAX_VERSION_LENGTH

public static final int MAX_VERSION_LENGTH

Maximum number of characters accepted for the version.

See Also:

• Constant Field Values

MAX_AUTHOR_LENGTH

public static final int MAX_AUTHOR_LENGTH

Maximum number of characters accepted for an author name.

See Also:

• Constant Field Values

MAX_DESCRIPTION_LENGTH

public static final int MAX_DESCRIPTION_LENGTH

Maximum number of characters accepted for the description.

See Also:

• Constant Field Values

MAX_HOMEPAGE_LENGTH

public static final int MAX_HOMEPAGE_LENGTH

Maximum number of characters accepted for the link to the homepage.

See Also:

• Constant Field Values

MAX_GAME_TYPE_LENGTH

public static final int MAX_GAME_TYPE_LENGTH

Maximum number of characters accepted for a game type.

See Also:

• Constant Field Values

MAX_PLATFORM_LENGTH

public static final int MAX_PLATFORM_LENGTH

Maximum number of characters accepted for the platform name.

See Also:

• Constant Field Values

MAX_PROGRAMMING_LANG_LENGTH

public static final int MAX_PROGRAMMING_LANG_LENGTH

Maximum number of characters accepted for the programming language name.

See Also:

• Constant Field Values

MAX_NUMBER_OF_AUTHORS

public static final int MAX_NUMBER_OF_AUTHORS

Maximum number of authors accepted.

See Also:

• Constant Field Values

MAX_NUMBER_OF_COUNTRY_CODES

public static final int MAX_NUMBER_OF_COUNTRY_CODES

Maximum number of country codes accepted.

See Also:

• Constant Field Values

MAX_NUMBER_OF_GAME_TYPES

public static final int MAX_NUMBER_OF_GAME_TYPES

Maximum number of game types accepted.

See Also:

• Constant Field Values

Constructor Details

BotInfo

public BotInfo(String name,
 String version,
 List<String> authors,
 String description,
 String homepage,
 List<String> countryCodes,
 Collection<String> gameTypes,
 String platform,
 String programmingLang,
 InitialPosition initialPosition)

Initializes a new instance of the BotInfo class.

Note that the recommended method for creating a BotInfo class is to use the BotInfo.IBuilder interface provided with the static builder() method.

Parameters:

name - is the name of the bot (required).

version - is the version of the bot (required).

authors - is the author(s) of the bot (required).

description - is a short description of the bot (optional).

homepage - is the link to a homepage for the bot (optional).

countryCodes - is the country code(s) for the bot (optional).

gameTypes - is the game types that this bot can handle (optional).

platform - is the platform used for running the bot (optional).

programmingLang - is the programming language used for developing the bot (optional).

initialPosition - is the initial position with starting coordinate and angle (optional).

Method Details

builder

public static BotInfo.IBuilder builder()

Returns a builder for a convenient way of building a BotInfo object using the builder pattern.

Example of use:

 BotInfo botInfo = BotInfo.builder()
     .setName("Rampage")
     .setVersion("1.0")
     .addAuthor("John Doh")
     .setGameTypes(List.of(GameType.CLASSIC, GameType.MELEE))
     .build();
 

Returns:

a builder for building a BotInfo object.

getName

public String getName()

Returns the name, e.g., "MyBot". This field must always be provided with the bot info.

Returns:

The name of the bot.

getVersion

public String getVersion()

Returns the version, e.g., "1.0". This field must always be provided with the bot info.

Returns:

The version of the bot.

getAuthors

public List<String> getAuthors()

Returns the list of authors of the bot, e.g., "John Doe (johndoe@somewhere.io)". At least one author must be provided.

Returns:

The name(s) of the author(s) of the bot.

getDescription

public String getDescription()

Returns a short description of the bot, preferably a one-liner.
This field is optional.

Returns:

a short description of the bot.

getHomepage

public String getHomepage()

Returns the URL of a web page for the bot.
This field is optional.

Returns:

The URL of a web page for the bot.

getCountryCodes

public List<String> getCountryCodes()

Returns a list of country code(s) defined by ISO 3166-1 alpha-2, e.g. { "us" } This field is optional. If no country codes are provided, the locale of the system is being used instead.

Returns:

The country code(s) for the bot.

getGameTypes

public Set<String> getGameTypes()

Returns the game type(s) accepted by the bot, e.g., "classic", "melee", "1v1". At least one game type must be provided to indicate the type(s) of games that this bot can participate in. The game types define which game types the bot can participate in. See GameType for using predefined game type.

Returns:

The game type(s) that this bot can handle.

getPlatform

public String getPlatform()

Returns the platform used for running the bot, e.g., "Java Runtime Environment (JRE) 11".
This field is optional.

Returns:

The platform used for running the bot.

getProgrammingLang

public String getProgrammingLang()

Returns the programming language used for developing the bot, e.g., "Java 11" or "Kotlin 1.7.20".
This field is optional.

Returns:

The programming language used for developing the bot.

getInitialPosition

public InitialPosition getInitialPosition()

Returns the initial starting position used for debugging only, which must be enabled at the server.
This field is optional.

Returns:

The initial starting position used for debugging only.

fromResourceFile

public static BotInfo fromResourceFile(String filename)

Reads the bot info from a resource file, e.g. when the file is located in a jar file or resource path in IDE.
The file is assumed to be in JSON format.

See the fromInputStream(java.io.InputStream) to see the required JSON format for the file.

Parameters:

filename - is the filename of the file containing bot properties.

Returns:

A BotInfo instance containing the bot properties read from the file.

Throws:

BotException - if the resource file could not be read, or if some field read from the file is invalid.

See Also:

• fromFile(java.lang.String)
• fromInputStream(java.io.InputStream)

fromFile

public static BotInfo fromFile(String filename)

Reads the bot info from a local file on a file system.
The file is assumed to be in JSON format.

See the fromInputStream(java.io.InputStream) to see the required JSON format for the file.

Parameters:

filename - is the filename of the file containing bot properties.

Returns:

A BotInfo instance containing the bot properties read from the file.

Throws:

BotException - if the file could not be read, or if some field read from the file is invalid.

See Also:

• fromResourceFile(java.lang.String)
• fromInputStream(java.io.InputStream)

fromInputStream

public static BotInfo fromInputStream(InputStream inputStream)

Reads the bot info from an input stream.
The file is assumed to be in JSON format.

Example file in JSON format:

 {
   "name": "MyBot",
   "version": "1.0",
   "authors": "John Doe",
   "description": "Short description",
   "homepage": "https://somewhere.net/MyBot",
   "countryCodes": "us",
   "gameTypes": "classic, melee, 1v1",
   "platform": "JVM",
   "programmingLang": "Java 11",
   "initialPosition": "50,50, 90"
 }
 

Note that these fields are required as these are used to identify the bot:

• name
• version
• authors

These value can take multiple values separated by a comma:

• authors, e.g. "John Doe, Jane Doe"
• countryCodes, e.g. "se, no, dk"
• gameTypes, e.g. "classic, melee, 1v1"

The initialPosition variable is optional and should only be used for debugging.

The gameTypes is optional, but can be used to limit which game types the bot is capable of participating in.

Parameters:

inputStream - is the input stream providing the bot properties.

Returns:

A BotInfo instance containing the bot properties read from the stream.

Throws:

BotException - if some fields read from the stream is invalid.

See Also:

• fromFile(java.lang.String)
• fromResourceFile(java.lang.String)