AdblockEngineProvider (adblock-android API)

All Known Implementing Classes:

SingleInstanceEngineProvider
```
public interface AdblockEngineProvider
```

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`AdblockEngineProvider.BeforeEngineDisposedListener`
`static interface`	`AdblockEngineProvider.EngineCreatedListener`
`static interface`	`AdblockEngineProvider.EngineDisposedListener`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`AdblockEngineProvider`	`addBeforeEngineDisposedListener(AdblockEngineProvider.BeforeEngineDisposedListener listener)`
`AdblockEngineProvider`	`addEngineCreatedListener(AdblockEngineProvider.EngineCreatedListener listener)`
`AdblockEngineProvider`	`addEngineDisposedListener(AdblockEngineProvider.EngineDisposedListener listener)`
`void`	`clearBeforeEngineDisposedListeners()`
`void`	`clearEngineCreatedListeners()`
`void`	`clearEngineDisposedListeners()`
`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

- Method Detail
  - retain
```
boolean retain(boolean asynchronous)
```
    Register AdblockEngine client
    
    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
```
void waitForReady()
```
    Wait until everything is ready (used for `retain(true)`) Warning: locks current thread
  - getEngine
```
AdblockEngine getEngine()
```
    Return AdblockEngine instance
    
    Returns:
    
    AdblockEngine instance. Can be `null` if not yet retained or already released
  - release
```
boolean release()
```
    Unregister AdblockEngine client
    
    Returns:
    
    `true` if the last instance is destroyed
  - getCounter
```
int getCounter()
```
    Get registered clients count
    
    Returns:
    
    registered clients count
  - getReadEngineLock
```
java.util.concurrent.locks.ReentrantReadWriteLock.ReadLock getReadEngineLock()
```
    Get lock object to prevent AdblockEngine reference from being changed
    
    Returns:
    
    read lock object
  - addEngineCreatedListener
```
AdblockEngineProvider addEngineCreatedListener(AdblockEngineProvider.EngineCreatedListener listener)
```
  - removeEngineCreatedListener
```
void removeEngineCreatedListener(AdblockEngineProvider.EngineCreatedListener listener)
```
  - clearEngineCreatedListeners
```
void clearEngineCreatedListeners()
```
  - addBeforeEngineDisposedListener
```
AdblockEngineProvider addBeforeEngineDisposedListener(AdblockEngineProvider.BeforeEngineDisposedListener listener)
```
  - removeBeforeEngineDisposedListener
```
void removeBeforeEngineDisposedListener(AdblockEngineProvider.BeforeEngineDisposedListener listener)
```
  - clearBeforeEngineDisposedListeners
```
void clearBeforeEngineDisposedListeners()
```
  - addEngineDisposedListener
```
AdblockEngineProvider addEngineDisposedListener(AdblockEngineProvider.EngineDisposedListener listener)
```
  - removeEngineDisposedListener
```
void removeEngineDisposedListener(AdblockEngineProvider.EngineDisposedListener listener)
```
  - clearEngineDisposedListeners
```
void clearEngineDisposedListeners()
```

Interface AdblockEngineProvider

Nested Class Summary

Method Summary

Method Detail

retain

waitForReady

getEngine

release

getCounter

getReadEngineLock

addEngineCreatedListener

removeEngineCreatedListener

clearEngineCreatedListeners

addBeforeEngineDisposedListener

removeBeforeEngineDisposedListener

clearBeforeEngineDisposedListeners

addEngineDisposedListener

removeEngineDisposedListener

clearEngineDisposedListeners