ly.count.sdk.java.internal

Class SDKModules

java.lang.Object

ly.count.sdk.java.internal.SDKModules

All Implemented Interfaces:

SDKInterface

Direct Known Subclasses:

SDKCore

public abstract class SDKModules
extends java.lang.Object
implements SDKInterface

Module-related methods of SDKInterface

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SDKModules.Modulator

Field Summary

Fields

Modifier and Type	Field and Description
protected int	consents Currently enabled features with consents
protected java.util.Map<java.lang.Integer,Module>	modules

Constructor Summary

Constructors

Constructor and Description
SDKModules()

Method Summary

Modifier and Type	Method and Description
protected void	buildModules(CtxCore ctx, int features) Create instances of Modules required by SDKInterface.config().
protected void	eachModule(SDKModules.Modulator modulator)
SessionImpl	getSession()
void	init(CtxCore ctx)
boolean	isTracking(java.lang.Integer feat) Check if consent has been given for a feature
<T extends Module> T	module(java.lang.Class<T> cls) Return module instance by Module class
protected Module	module(int feature) Return module instance by ConfigCore.Feature
void	onConsent(CtxCore ctx, int consent) Callback to add consents to the list
void	onConsentRemoval(CtxCore ctx, int noConsent) Callback to remove consents from the list
SessionImpl	onSessionBegan(CtxCore ctx, SessionImpl session) Notify all Module instances about new session has just been started
SessionImpl	onSessionEnded(CtxCore ctx, SessionImpl session) Notify all Module instances session was ended
protected void	prepareMappings(CtxCore ctx) Create instances of Modules required by SDKInterface.config().
protected static void	registerDefaultModuleMapping(int feature, java.lang.Class<? extends Module> cls)
protected static void	registerModuleMapping(int feature, java.lang.Class<? extends Module> cls)
SessionImpl	session(CtxCore ctx, java.lang.Long id) Get current SessionImpl or create new one if current is null.
void	stop(CtxCore ctx, boolean clear)

Methods inherited from class java.lang.Object

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

Methods inherited from interface ly.count.sdk.java.internal.SDKInterface

config, onCrash, onDeviceId, onRequest, onSignal, onSignal, onUserChanged, storableList, storablePop, storablePurge, storableRead, storableReadBytes, storableReadBytes, storableReadBytesOneOf, storableRemove, storableWrite, storableWrite, user

Field Detail

consents

protected int consents

Currently enabled features with consents

modules

protected java.util.Map<java.lang.Integer,Module> modules

Constructor Detail

SDKModules

public SDKModules()

Method Detail

registerDefaultModuleMapping

protected static void registerDefaultModuleMapping(int feature,
                                                   java.lang.Class<? extends Module> cls)

registerModuleMapping

protected static void registerModuleMapping(int feature,
                                            java.lang.Class<? extends Module> cls)

isTracking

public boolean isTracking(java.lang.Integer feat)

Check if consent has been given for a feature

Parameters:

feat - feature to test against, pass null to test if any consent given

Returns:

true if consent has been given

init

public void init(CtxCore ctx)

Specified by:

init in interface SDKInterface

stop

public void stop(CtxCore ctx,
                 boolean clear)

Specified by:

stop in interface SDKInterface

onConsent

public void onConsent(CtxCore ctx,
                      int consent)

Callback to add consents to the list

Parameters:

consent - consents to add

onConsentRemoval

public void onConsentRemoval(CtxCore ctx,
                             int noConsent)

Callback to remove consents from the list

Parameters:

noConsent - consents to remove

prepareMappings

protected void prepareMappings(CtxCore ctx)
                        throws java.lang.IllegalStateException

Create instances of Modules required by SDKInterface.config(). Uses moduleMappings for ConfigCore.Feature / CoreFeature - Class<Module> mapping to enable overriding by app developer.

Parameters:

ctx - CtxCore object containing config with mapping overrides

Throws:

java.lang.IllegalArgumentException - in case some Module finds SDKInterface.config() inconsistent.

java.lang.IllegalStateException - when this module is run second time on the same Core instance.

buildModules

protected void buildModules(CtxCore ctx,
                            int features)
                     throws java.lang.IllegalArgumentException,
                            java.lang.IllegalStateException

Create instances of Modules required by SDKInterface.config(). Uses moduleMappings for ConfigCore.Feature / CoreFeature - Class<Module> mapping to enable overriding by app developer.

Parameters:

ctx - CtxCore object

features - consents bitmask to check against

Throws:

java.lang.IllegalArgumentException - in case some Module finds SDKInterface.config() inconsistent.

java.lang.IllegalStateException - when this module is run second time on the same Core instance.

module

protected Module module(int feature)

Return module instance by ConfigCore.Feature

Parameters:

feature - to get a Module instance for

Returns:

Module instance or null if no such module is instantiated

module

public <T extends Module> T module(java.lang.Class<T> cls)

Return module instance by Module class

Parameters:

cls - class to get a Module instance for

Returns:

Module instance or null if no such module is instantiated

eachModule

protected void eachModule(SDKModules.Modulator modulator)

onSessionBegan

public SessionImpl onSessionBegan(CtxCore ctx,
                                  SessionImpl session)

Description copied from interface: SDKInterface

Notify all Module instances about new session has just been started

Specified by:

onSessionBegan in interface SDKInterface

session - session to begin

Returns:

supplied session for method chaining

onSessionEnded

public SessionImpl onSessionEnded(CtxCore ctx,
                                  SessionImpl session)

Description copied from interface: SDKInterface

Notify all Module instances session was ended

Specified by:

onSessionEnded in interface SDKInterface

session - session to end

Returns:

supplied session for method chaining

getSession

public SessionImpl getSession()

Specified by:

getSession in interface SDKInterface

session

public SessionImpl session(CtxCore ctx,
                           java.lang.Long id)

Description copied from interface: SDKInterface

Get current SessionImpl or create new one if current is null.

Specified by:

session in interface SDKInterface

Parameters:

ctx - Ctx to create new SessionImpl in

id - ID of new SessionImpl if needed

Returns:

current SessionImpl instance