basestation.bot

Class BotManager

java.lang.Object

basestation.bot.BotManager

public class BotManager
extends java.lang.Object

Tracks and manages all bots. Any bot that you create a connection to should be tracked under this manager to prevent errors. Bots are uniquely identified by their names.

Constructor Summary

Constructors

Constructor and Description
BotManager() Initializes the bot manager with a fresh map and counter

Method Summary

Modifier and Type	Method and Description
java.lang.String	addBot(Bot bot) Begins tracking bot under the BotManager and return its managed name
int	generateBotNumber() Returns the next available int for a bot number.
java.util.Collection<Bot>	getAllTrackedBots() Gets all the bots currently tracked
java.util.Optional<Bot>	getBotByName(java.lang.String name) Returns the bot associated with name if it exists
java.util.Optional<Bot>	removeBotByName(java.lang.String botName) Removes bot with id botId from the botMap and returns it

Methods inherited from class java.lang.Object

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

Constructor Detail

BotManager

public BotManager()

Initializes the bot manager with a fresh map and counter

Method Detail

addBot

public java.lang.String addBot(Bot bot)

Begins tracking bot under the BotManager and return its managed name

Parameters:

bot - The bot object that was created for the bot

Returns:

The name of the bot

getBotByName

public java.util.Optional<Bot> getBotByName(java.lang.String name)

Returns the bot associated with name if it exists

Parameters:

name - The name provided for the bot when it was created

Returns:

The bot or null if it does not exist

removeBotByName

public java.util.Optional<Bot> removeBotByName(java.lang.String botName)

Removes bot with id botId from the botMap and returns it

Parameters:

botName - the managed name of the bot

Returns:

An optional of the removed bot

getAllTrackedBots

public java.util.Collection<Bot> getAllTrackedBots()

Gets all the bots currently tracked

Returns:

A collection of all bots being tracked by the BotManager.

generateBotNumber

public int generateBotNumber()

Returns the next available int for a bot number. This increments the botCounter. Generally should not be used by anyone using the BaseStation.

Returns:

the next available int