org.adblockplus.libadblockplus.android

Class SingleInstanceEngineProvider

java.lang.Object

org.adblockplus.libadblockplus.android.SingleInstanceEngineProvider

All Implemented Interfaces:

AdblockEngineProvider

public class SingleInstanceEngineProvider
extends java.lang.Object
implements AdblockEngineProvider

Provides single instance of AdblockEngine shared between registered clients

Nested Class Summary

Nested classes/interfaces inherited from interface org.adblockplus.libadblockplus.android.AdblockEngineProvider

AdblockEngineProvider.BeforeEngineDisposedListener, AdblockEngineProvider.EngineCreatedListener, AdblockEngineProvider.EngineDisposedListener

Constructor Summary

Constructors

Constructor and Description
SingleInstanceEngineProvider(AdblockEngine.Factory engineFactory) Init with factory

Method Summary

Modifier and Type	Method and Description
SingleInstanceEngineProvider	addBeforeEngineDisposedListener(AdblockEngineProvider.BeforeEngineDisposedListener listener)
SingleInstanceEngineProvider	addEngineCreatedListener(AdblockEngineProvider.EngineCreatedListener listener)
SingleInstanceEngineProvider	addEngineDisposedListener(AdblockEngineProvider.EngineDisposedListener listener)
void	clearBeforeEngineDisposedListeners()
void	clearEngineCreatedListeners()
void	clearEngineDisposedListeners()
protected java.util.concurrent.ExecutorService	createExecutorService()
int	getCounter() Get registered clients count
AdblockEngine	getEngine() Return AdblockEngine instance
java.util.concurrent.locks.ReentrantReadWriteLock.ReadLock	getReadEngineLock() Get lock object to prevent AdblockEngine reference from being changed
boolean	release() Unregister AdblockEngine client
void	removeBeforeEngineDisposedListener(AdblockEngineProvider.BeforeEngineDisposedListener listener)
void	removeEngineCreatedListener(AdblockEngineProvider.EngineCreatedListener listener)
void	removeEngineDisposedListener(AdblockEngineProvider.EngineDisposedListener listener)
boolean	retain(boolean asynchronous) Register AdblockEngine client
void	waitForReady() Wait until everything is ready (used for `retain(true)`) Warning: locks current thread

Methods inherited from class java.lang.Object

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

Constructor Detail

SingleInstanceEngineProvider

public SingleInstanceEngineProvider(AdblockEngine.Factory engineFactory)

Init with factory

Parameters:

engineFactory - Factory to build AdblockEngine

Method Detail

createExecutorService

protected java.util.concurrent.ExecutorService createExecutorService()

addEngineCreatedListener

public SingleInstanceEngineProvider addEngineCreatedListener(AdblockEngineProvider.EngineCreatedListener listener)

Specified by:

addEngineCreatedListener in interface AdblockEngineProvider

removeEngineCreatedListener

public void removeEngineCreatedListener(AdblockEngineProvider.EngineCreatedListener listener)

Specified by:

removeEngineCreatedListener in interface AdblockEngineProvider

clearEngineCreatedListeners

public void clearEngineCreatedListeners()

Specified by:

clearEngineCreatedListeners in interface AdblockEngineProvider

addBeforeEngineDisposedListener

public SingleInstanceEngineProvider addBeforeEngineDisposedListener(AdblockEngineProvider.BeforeEngineDisposedListener listener)

Specified by:

addBeforeEngineDisposedListener in interface AdblockEngineProvider

removeBeforeEngineDisposedListener

public void removeBeforeEngineDisposedListener(AdblockEngineProvider.BeforeEngineDisposedListener listener)

Specified by:

removeBeforeEngineDisposedListener in interface AdblockEngineProvider

clearBeforeEngineDisposedListeners

public void clearBeforeEngineDisposedListeners()

Specified by:

clearBeforeEngineDisposedListeners in interface AdblockEngineProvider

addEngineDisposedListener

public SingleInstanceEngineProvider addEngineDisposedListener(AdblockEngineProvider.EngineDisposedListener listener)

Specified by:

addEngineDisposedListener in interface AdblockEngineProvider

removeEngineDisposedListener

public void removeEngineDisposedListener(AdblockEngineProvider.EngineDisposedListener listener)

Specified by:

removeEngineDisposedListener in interface AdblockEngineProvider

clearEngineDisposedListeners

public void clearEngineDisposedListeners()

Specified by:

clearEngineDisposedListeners in interface AdblockEngineProvider

retain

public boolean retain(boolean asynchronous)

Description copied from interface: AdblockEngineProvider

Register AdblockEngine client

Specified by:

retain in interface AdblockEngineProvider

Parameters:

asynchronous - If `true` engines will be created in background thread without locking of current thread. Use waitForReady() before getEngine() later. If `false` locks current thread.

Returns:

if a new instance is allocated

waitForReady

public void waitForReady()

Description copied from interface: AdblockEngineProvider

Wait until everything is ready (used for `retain(true)`) Warning: locks current thread

Specified by:

waitForReady in interface AdblockEngineProvider

getEngine

public AdblockEngine getEngine()

Description copied from interface: AdblockEngineProvider

Return AdblockEngine instance

Specified by:

getEngine in interface AdblockEngineProvider

Returns:

AdblockEngine instance. Can be `null` if not yet retained or already released

release

public boolean release()

Description copied from interface: AdblockEngineProvider

Unregister AdblockEngine client

Specified by:

release in interface AdblockEngineProvider

Returns:

`true` if the last instance is destroyed

getCounter

public int getCounter()

Description copied from interface: AdblockEngineProvider

Get registered clients count

Specified by:

getCounter in interface AdblockEngineProvider

Returns:

registered clients count

getReadEngineLock

public java.util.concurrent.locks.ReentrantReadWriteLock.ReadLock getReadEngineLock()

Description copied from interface: AdblockEngineProvider

Get lock object to prevent AdblockEngine reference from being changed

Specified by:

getReadEngineLock in interface AdblockEngineProvider

Returns:

read lock object