nintaco.api

Class ApiSource

java.lang.Object

nintaco.api.ApiSource

public final class ApiSource
extends java.lang.Object

A factory that provides the handle to the API and the way to setup the Remote API. Only one instance of the API exists during the lifetime of a program run; as far as a program is concerned, the API is a singleton and this factory provides the means of getting a reference to it. Classes interested in using the API can declare an object constant via the following code to make the reference available to all methods.

private final API api = ApiSource.getAPI();

For the Remote API, initRemoteAPI must be invoked prior to any of the calls to getAPI.

Method Summary

Modifier and Type	Method and Description
static API	getAPI() Provides the handle to the API.
static void	initRemoteAPI(java.lang.String host, int port) Initializes the Remote API.

Methods inherited from class java.lang.Object

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

Method Detail

getAPI

public static API getAPI()

Provides the handle to the API. The API is not enabled until API.run() is called.

Returns:

The handle to the API. Or, null when used remotely prior to calling initRemoteAPI.

See Also:

initRemoteAPI(java.lang.String, int), API.run()

initRemoteAPI

public static void initRemoteAPI(java.lang.String host,
                                 int port)

Initializes the Remote API. This method should be invoked near the program entrypoint, prior to any calls to getAPI. Calling this method informs the factory that it should provide a remote proxy implementation. However, a socket connection is not established until API.run() is called. In between initRemoteAPI() and run(), listeners should be added.

Parameters:

host - The hostname of the machine on which the Program Server is running.

port - The port number on which the Program Server is listening.

See Also:

getAPI(), API.run()