A B C D E F G H I J L N O P R S T U V

A

AbstractClientDetails - Class in com.camelspotting.jotl.domain
 
AbstractClientDetails(List<Company>) - Constructor for class com.camelspotting.jotl.domain.AbstractClientDetails
 
addListeners(OpenTTDListener...) - Method in class com.camelspotting.jotl.ServerMonitor
Method for registering listeners for any events.

B

BitUtil - Class in com.camelspotting.jotl.udp
 

C

ClientsDetails - Interface in com.camelspotting.jotl.domain
 
ClientsDetailsV5 - Class in com.camelspotting.jotl.domain
 
ClientsDetailsV5(List<Company>) - Constructor for class com.camelspotting.jotl.domain.ClientsDetailsV5
 
com.camelspotting.jotl - package com.camelspotting.jotl
This package contains the main library.
com.camelspotting.jotl.domain - package com.camelspotting.jotl.domain
 
com.camelspotting.jotl.event - package com.camelspotting.jotl.event
The event package contains classes useful for generating, parsing and listening to game events.
com.camelspotting.jotl.exceptions - package com.camelspotting.jotl.exceptions
 
com.camelspotting.jotl.parsing - package com.camelspotting.jotl.parsing
 
com.camelspotting.jotl.udp - package com.camelspotting.jotl.udp
 
com.camelspotting.jotl.util - package com.camelspotting.jotl.util
 
Company - Class in com.camelspotting.jotl.domain
This class represents a company currently in the game.
Company(int, String, int, long, long, long, int, boolean, Map<Vehicle, Integer>, Map<Station, Integer>) - Constructor for class com.camelspotting.jotl.domain.Company
The constructor for companies.
compareTo(Company) - Method in class com.camelspotting.jotl.domain.Company
This method makes the companies comparable based on their rating.
convertDateToYMD(int) - Static method in class com.camelspotting.jotl.udp.DateUtil
Method for parsing the date to something readable.
convertYMDToDate(LocalDate) - Static method in class com.camelspotting.jotl.udp.DateUtil
 
createPacket(InetAddress, int) - Method in enum com.camelspotting.jotl.udp.PacketType
This method constructs a DatagramPacket ready for send-off to the OpenTTD-server.

D

DateUtil - Class in com.camelspotting.jotl.udp
This class is a conversion of the date conversion methods from the OpenTTD codebase.

E

equals(Object) - Method in class com.camelspotting.jotl.domain.Company
This method returns true if two companies have the same currentID.
equals(Object) - Method in class com.camelspotting.jotl.NewGRF
 
eventOccured(OpenTTDEvent) - Method in interface com.camelspotting.jotl.event.OpenTTDListener
Method is invoked every time an event occurs.

F

fromInt(int) - Static method in enum com.camelspotting.jotl.udp.PacketType
 

G

Game - Class in com.camelspotting.jotl.domain
This method is is just a wrapper for response and detail information, and is primarily used for archiving the final query result for games in ServerHandler.
Game(ServerDetails, ClientsDetails) - Constructor for class com.camelspotting.jotl.domain.Game
This internal constructor is for creating these archive objects.
GameQuerier - Interface in com.camelspotting.jotl
 
getAddress() - Method in class com.camelspotting.jotl.domain.Server
 
getAllInformation() - Method in interface com.camelspotting.jotl.GameQuerier
Method for getting all available information
getAllInformation() - Method in class com.camelspotting.jotl.udp.UDPGameQuerier
 
getBalance() - Method in class com.camelspotting.jotl.domain.Company
Method for getting the company's current balance.
getClientDetails() - Method in class com.camelspotting.jotl.domain.Game
Getter for the ClientsInfo object.
getClientsDetails() - Method in interface com.camelspotting.jotl.GameQuerier
Method for accessing details on the connected clients.
getClientsDetails() - Method in class com.camelspotting.jotl.udp.UDPGameQuerier
 
getCompanies() - Method in class com.camelspotting.jotl.domain.AbstractClientDetails
 
getCompanies() - Method in interface com.camelspotting.jotl.domain.ClientsDetails
 
getCompanyName() - Method in class com.camelspotting.jotl.domain.Company
Method for getting the company's name
getCompanyValue() - Method in class com.camelspotting.jotl.domain.Company
Method for getting the company's current value.
getCurrentId() - Method in class com.camelspotting.jotl.domain.Company
Method for getting the current ID of a company
getDescription() - Method in enum com.camelspotting.jotl.event.OpenTTDEventType
 
getDescription() - Method in enum com.camelspotting.jotl.parsing.Station
 
getDescription() - Method in enum com.camelspotting.jotl.parsing.Vehicle
 
getFormattedBalance() - Method in class com.camelspotting.jotl.domain.Company
Method for getting the company's current balance in a format suitable for display.
getFormattedCompanyValue() - Method in class com.camelspotting.jotl.domain.Company
Method for getting the company's current value in a format suitable for display.
getFormattedIncome() - Method in class com.camelspotting.jotl.domain.Company
Method for getting the company's current income in a format suitable for display.
getGameDate() - Method in class com.camelspotting.jotl.domain.ServerDetails
Method for getting the current game date so that other formatting may be applied.
getGraphicsCount() - Method in class com.camelspotting.jotl.domain.ServerDetails
Getter for the server new graphics count.
getId() - Method in class com.camelspotting.jotl.NewGRF
Getter for id.
getId() - Method in enum com.camelspotting.jotl.parsing.Station
 
getId() - Method in enum com.camelspotting.jotl.parsing.Vehicle
 
getInaugerationYear() - Method in class com.camelspotting.jotl.domain.Company
Method for getting the company's inaugeration year.
getIncome() - Method in class com.camelspotting.jotl.domain.Company
Method for getting the company's current income.
getIpAddress() - Method in class com.camelspotting.jotl.domain.Server
 
getLength() - Method in class com.camelspotting.jotl.udp.PacketMetadata
The specified length of data packet
getLongDate(int[], Locale) - Static method in class com.camelspotting.jotl.util.Util
Method for getting a date converted to a string with a long month.
getMapHeight() - Method in class com.camelspotting.jotl.domain.ServerDetails
Getter for the current map's height.
getMapName() - Method in class com.camelspotting.jotl.domain.ServerDetails
Getter for the current map's name
getMapWidth() - Method in class com.camelspotting.jotl.domain.ServerDetails
Getter for the current map's width.
getMaxNumberOfClients() - Method in class com.camelspotting.jotl.domain.ServerDetails
Getter for maximum number of clients
getMaxNumberOfCompanies() - Method in class com.camelspotting.jotl.domain.ServerDetails
Getter for maximum number of companies
getMaxNumberOfSpectators() - Method in class com.camelspotting.jotl.domain.ServerDetails
Getter for maximum number of specatators.
getMD5Checksum() - Method in class com.camelspotting.jotl.NewGRF
Getter for MD5 checksum.
getName() - Method in class com.camelspotting.jotl.domain.Server
 
getName() - Method in class com.camelspotting.jotl.NewGRF
Getter for the graphic's name
getNewGRFs() - Method in class com.camelspotting.jotl.domain.ServerDetails
 
getNumberOfActiveClients() - Method in class com.camelspotting.jotl.domain.ServerDetails
Getter for the number of active clients.
getNumberOfActiveCompanies() - Method in class com.camelspotting.jotl.domain.ServerDetails
Getter for the number of active companies.
getNumberOfActiveSpectators() - Method in class com.camelspotting.jotl.domain.ServerDetails
Getter for the number of active spectators.
getNumberOfStations() - Method in class com.camelspotting.jotl.domain.Company
Method for accessing how many stations a company has.
getNumberOfVehicles() - Method in class com.camelspotting.jotl.domain.Company
Method for accessing how many vehicles a company has.
getObjects() - Method in class com.camelspotting.jotl.event.OpenTTDEvent
Depending on what type of event this is this array contains different objects.
getPacketOrigin() - Method in enum com.camelspotting.jotl.udp.PacketType
Where does this packet type come from?
getPort() - Method in class com.camelspotting.jotl.domain.Server
 
getRating() - Method in class com.camelspotting.jotl.domain.Company
Method for getting the company's current rating.
getServer() - Method in exception com.camelspotting.jotl.exceptions.IllegalHostException
 
getServer() - Method in exception com.camelspotting.jotl.exceptions.UnreachableHostException
 
getServer() - Method in interface com.camelspotting.jotl.GameQuerier
Returns server related information.
getServer() - Method in class com.camelspotting.jotl.udp.UDPGameQuerier
 
getServerDetails() - Method in class com.camelspotting.jotl.domain.Game
Getter for the ServerInfo object.
getServerDetails() - Method in interface com.camelspotting.jotl.GameQuerier
Method for accessing server details.
getServerDetails() - Method in class com.camelspotting.jotl.udp.UDPGameQuerier
 
getServerLanguage() - Method in class com.camelspotting.jotl.domain.ServerDetails
Getter for the server's language index.
getServerLanguageAsString() - Method in class com.camelspotting.jotl.domain.ServerDetails
Getter for the server's language.
getServerName() - Method in class com.camelspotting.jotl.domain.ServerDetails
Getter for the server name.
getServerName() - Method in class com.camelspotting.jotl.ServerMonitor
Getter for the monitored server's hostname.
getShortDate(int[], Locale) - Static method in class com.camelspotting.jotl.util.Util
Method for getting a date converted to a string with a short month.
getStartDate() - Method in class com.camelspotting.jotl.domain.ServerDetails
Method for getting the start date so that other formatting may be applied.
getTileset() - Method in class com.camelspotting.jotl.domain.ServerDetails
Getter for the tileset of the map
getTilesetAsString() - Method in class com.camelspotting.jotl.domain.ServerDetails
Getter for the meaning of the tileset integer.
getType() - Method in class com.camelspotting.jotl.event.OpenTTDEvent
This method returns the type of event.
getType() - Method in class com.camelspotting.jotl.udp.PacketMetadata
The specified data packet type
getVersion() - Method in class com.camelspotting.jotl.domain.ServerDetails
Getter for the game version.
getVersion() - Method in class com.camelspotting.jotl.udp.PacketMetadata
The specified UDP version of the data packet
getVersionComponents() - Method in class com.camelspotting.jotl.domain.ServerDetails
Getter for game version as components: major.minor.revision

H

hashCode() - Method in class com.camelspotting.jotl.domain.Company
 
hashCode() - Method in class com.camelspotting.jotl.NewGRF
 

I

IllegalHostException - Exception in com.camelspotting.jotl.exceptions
 
IllegalHostException(Server, Throwable) - Constructor for exception com.camelspotting.jotl.exceptions.IllegalHostException
 
isDedicated() - Method in class com.camelspotting.jotl.domain.ServerDetails
Method for finding out whether or not the server is running in dedicated mode or if it is participating as a client.
isPasswordProtected() - Method in class com.camelspotting.jotl.domain.Company
Method for finding out whether or not the company is password protected.
isPasswordProtected() - Method in class com.camelspotting.jotl.domain.ServerDetails
Method for finding out whether or not the server is password protected.
isPaused() - Method in class com.camelspotting.jotl.ServerMonitor
Getter for easily finding out whether the game is paused or not.

J

JOTLException - Exception in com.camelspotting.jotl.exceptions
All exceptions that happen in the code are wrapped inside OpenTTD-exceptions.
JOTLException(String) - Constructor for exception com.camelspotting.jotl.exceptions.JOTLException
Main constructor for these exceptions.
JOTLException(Throwable) - Constructor for exception com.camelspotting.jotl.exceptions.JOTLException
Simple constructor with no message.
JOTLException(String, Throwable) - Constructor for exception com.camelspotting.jotl.exceptions.JOTLException
Main constructor for these exceptions.

L

locateNextZero(byte[], int) - Static method in class com.camelspotting.jotl.parsing.ParseUtil
Finds first zero from offset.

N

NewGRF - Class in com.camelspotting.jotl
This class represents any graphics requests.
NewGRF(String, String, String) - Constructor for class com.camelspotting.jotl.NewGRF
Simple constructor.
NewGRF(String, String) - Constructor for class com.camelspotting.jotl.NewGRF
Simpler constructor.

O

OpenTTDEvent - Class in com.camelspotting.jotl.event
This class represents the events that may occur during an OpenTTD-game.
OpenTTDEvent(OpenTTDEventType, Object...) - Constructor for class com.camelspotting.jotl.event.OpenTTDEvent
Constructor for making events.
OpenTTDEventType - Enum in com.camelspotting.jotl.event
This enum represents the type of OpenTTD events.
OpenTTDListener - Interface in com.camelspotting.jotl.event
Any classes that is to monitor an OpenTTD-server and it's games will have to implement this interface and register with the ServerHandler to recieve events.

P

PacketMetadata - Class in com.camelspotting.jotl.udp
 
PacketType - Enum in com.camelspotting.jotl.udp
This enum is for enumerating the different types of UDP packets that the OpenTTD server will understand and aknowledge.
PacketType.PacketOrigin - Enum in com.camelspotting.jotl.udp
 
parse16BitNumber(byte[], int) - Static method in class com.camelspotting.jotl.udp.BitUtil
Method for parsing 2 bytes.
parse32BitNumber(byte[], int) - Static method in class com.camelspotting.jotl.udp.BitUtil
Method for parsing 4 bytes.
parse64BitNumber(byte[], int) - Static method in class com.camelspotting.jotl.udp.BitUtil
Method for parsing 16 bytes.
parse8BitNumber(byte[], int) - Static method in class com.camelspotting.jotl.udp.BitUtil
Method for parsing 1 byte.
parseClientsDetails(byte[]) - Static method in class com.camelspotting.jotl.udp.UDPPacketParser
Based on OpenTTD source code: Source file: src/network/core/network_udp.cpp Packet sending code: Receive_CLIENT_DETAIL_INFO Packet parsing code: ?
parseHost(String, int) - Static method in class com.camelspotting.jotl.parsing.ParseUtil
This method checks if host is an IP-address via regex and parses it or if not, does a DNS look up on it.
parseMetadata(byte[]) - Static method in class com.camelspotting.jotl.udp.PacketMetadata
 
parseServerDetails(byte[]) - Static method in class com.camelspotting.jotl.udp.UDPPacketParser
Based on OpenTTD source code: Source file: src/network/core/udp.cpp Packet sending code: SendNetworkGameInfo Packet parsing code: ReceiveNetworkGameInfo
parseString(byte[], int, int) - Static method in class com.camelspotting.jotl.parsing.ParseUtil
Method for parsing contents of offset byte array to offset String.
ParseUtil - Class in com.camelspotting.jotl.parsing
This is a class of static parse support methods, so no methods are visible to applications using jOpenTTDLib.

R

removeListeners(OpenTTDListener...) - Method in class com.camelspotting.jotl.ServerMonitor
Method for deregistering listeners.

S

Server - Class in com.camelspotting.jotl.domain
 
Server(String, String, int, InetAddress) - Constructor for class com.camelspotting.jotl.domain.Server
 
Server(String, int, InetAddress) - Constructor for class com.camelspotting.jotl.domain.Server
 
ServerDetails - Class in com.camelspotting.jotl.domain
This class is for parsing and holding the information from the server response package.
ServerDetails(List<NewGRF>, String, LocalDate, LocalDate, int, int, int, int, int, int, String, int, boolean, boolean, int, int, int, String) - Constructor for class com.camelspotting.jotl.domain.ServerDetails
 
ServerMonitor - Class in com.camelspotting.jotl
This is one of the primary access points for any user of the library.
ServerMonitor(GameQuerier, int, boolean, OpenTTDListener...) - Constructor for class com.camelspotting.jotl.ServerMonitor
Main constructor for creating the server handler.
setUpdateInterval(int) - Method in class com.camelspotting.jotl.ServerMonitor
This method is for altering the update interval.
start() - Method in class com.camelspotting.jotl.ServerMonitor
This method is for starting the continous updating.
Station - Enum in com.camelspotting.jotl.parsing
 
stop() - Method in class com.camelspotting.jotl.ServerMonitor
This method overrides the setUpdateInterval-method that refuses to lower the interval to lower than 2000 and sets it to -1.

T

toStation(int) - Static method in enum com.camelspotting.jotl.parsing.Station
 
toString() - Method in class com.camelspotting.jotl.domain.AbstractClientDetails
Method for getting a textual representation of this object.
toString() - Method in class com.camelspotting.jotl.domain.Company
Convenience method for printing out relevant information for display.
toString() - Method in class com.camelspotting.jotl.domain.Game
 
toString() - Method in class com.camelspotting.jotl.domain.Server
 
toString() - Method in class com.camelspotting.jotl.domain.ServerDetails
Method for getting a textual representation of this object.
toString() - Method in class com.camelspotting.jotl.event.OpenTTDEvent
This gives a description of this event.
toString() - Method in enum com.camelspotting.jotl.event.OpenTTDEventType
Returns a textual description of the enum.
toString() - Method in class com.camelspotting.jotl.NewGRF
 
toString() - Method in class com.camelspotting.jotl.udp.PacketMetadata
 
toUnsignedInt(byte) - Static method in class com.camelspotting.jotl.udp.BitUtil
 
toUnsignedIntegers(byte[]) - Static method in class com.camelspotting.jotl.udp.BitUtil
 
toUnsignedLongs(byte[]) - Static method in class com.camelspotting.jotl.udp.BitUtil
 
toVehicle(int) - Static method in enum com.camelspotting.jotl.parsing.Vehicle
 

U

UDPGameQuerier - Class in com.camelspotting.jotl.udp
This is one of the primary access points for any user of the library.
UDPGameQuerier(String, int, int) - Constructor for class com.camelspotting.jotl.udp.UDPGameQuerier
Main constructor for class.
UDPPacketParser - Class in com.camelspotting.jotl.udp
 
UnreachableHostException - Exception in com.camelspotting.jotl.exceptions
 
UnreachableHostException(Server, Throwable) - Constructor for exception com.camelspotting.jotl.exceptions.UnreachableHostException
 
update() - Method in class com.camelspotting.jotl.ServerMonitor
This method is public so that any API-user might update manually. also for the automatic update process.
Util - Class in com.camelspotting.jotl.util
 

V

valueOf(String) - Static method in enum com.camelspotting.jotl.event.OpenTTDEventType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.camelspotting.jotl.parsing.Station
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.camelspotting.jotl.parsing.Vehicle
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.camelspotting.jotl.udp.PacketType.PacketOrigin
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.camelspotting.jotl.udp.PacketType
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.camelspotting.jotl.event.OpenTTDEventType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.camelspotting.jotl.parsing.Station
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.camelspotting.jotl.parsing.Vehicle
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.camelspotting.jotl.udp.PacketType.PacketOrigin
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.camelspotting.jotl.udp.PacketType
Returns an array containing the constants of this enum type, in the order they are declared.
Vehicle - Enum in com.camelspotting.jotl.parsing
 

A B C D E F G H I J L N O P R S T U V

Copyright © 2013. All Rights Reserved.