com.percolate.foam

Class FoamMain

java.lang.Object

com.percolate.foam.FoamMain

class FoamMain
extends java.lang.Object

Foam Main class. Contains logic to initialize, start, and run Foam for an application. This class should be started by FoamApplicationInit. To add new services to foam, modify init(FoamApiKeys) to add your new service to our services map, then modify initializeServices() to pass the correct API key to the service. More details can be found in the README / wiki.

Field Summary

Fields

Modifier and Type	Field and Description
private android.content.Context	context
(package private) CustomExceptionHandler	customExceptionHandler
(package private) EventTracker	eventTracker
(package private) FoamApiKeys	foamApiKeys
(package private) LogListener	logListener
(package private) java.util.Map<ServiceType,Service>	services

Constructor Summary

Constructors

Constructor and Description
FoamMain(android.content.Context context)

Method Summary

Modifier and Type	Method and Description
(package private) <T extends Service> java.util.List<T>	getEnabledServicesForType(java.lang.Class<T> clazz) Return Service classes defined in services that match the given interface (one of Service's child interfaces).
protected void	init(FoamApiKeys foamApiKeys) Add all services to services map, with an associated ServiceType enum.
(package private) void	initializeServices() Loop through all services.
(package private) void	logEvent(android.content.Context context, java.lang.String event) Used by FoamEvent to log custom events.
(package private) void	start() Start up Foam!
(package private) void	startCustomExceptionHandler() Start Foam custom exception handler class.
(package private) void	startEventTracker() Start Foam event tracker.
(package private) void	startLogListener() Start Foam log listener class.
(package private) void	stop() Disable foam

Methods inherited from class java.lang.Object

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

Field Detail

context

private android.content.Context context

foamApiKeys

FoamApiKeys foamApiKeys

services

java.util.Map<ServiceType,Service> services

eventTracker

EventTracker eventTracker

customExceptionHandler

CustomExceptionHandler customExceptionHandler

logListener

LogListener logListener

Constructor Detail

FoamMain

FoamMain(android.content.Context context)

Method Detail

init

protected void init(FoamApiKeys foamApiKeys)

Add all services to services map, with an associated ServiceType enum.

Parameters:

foamApiKeys - Instance of FoamApiKeys used to initialize foam services.

start

void start()

Start up Foam!

stop

void stop()

Disable foam

initializeServices

void initializeServices()

Loop through all services. If there is a corresponding API key defined in FoamApiKeys, then enable the service using that key. Otherwise service will remain disabled.

startCustomExceptionHandler

void startCustomExceptionHandler()

Start Foam custom exception handler class.

See Also:

CustomExceptionHandler

startLogListener

void startLogListener()

Start Foam log listener class.

See Also:

LogListener

startEventTracker

void startEventTracker()

Start Foam event tracker. Checks for duplicate restarts.

See Also:

EventTracker

getEnabledServicesForType

<T extends Service> java.util.List<T> getEnabledServicesForType(java.lang.Class<T> clazz)

Return Service classes defined in services that match the given interface (one of Service's child interfaces).

Type Parameters:

T - Type for the option value

Parameters:

clazz - Interface (child of Service interface). The returned List will be all Service's from our services map that can be cast to this interface type.

Returns:

List of type T. This is a list of all Services that are of the pass in interface type.

logEvent

void logEvent(android.content.Context context,
              java.lang.String event)

Used by FoamEvent to log custom events.

Parameters:

context - Context

event - Event name to track.