BlockCanaryContext (blockcanary-analyzer API)

java.lang.Object
- com.github.moduth.blockcanary.BlockCanaryContext

```
public class BlockCanaryContext
extends java.lang.Object
```
User should provide a real implementation of this class to use BlockCanary.

构造器概要

构造器
构造器和说明

BlockCanaryContext()

构造器
构造器和说明
`BlockCanaryContext()`

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`java.util.List<java.lang.String>`	`concernPackages()` Packages that developer concern, by default it uses process name, put high priority one in pre-order.
`boolean`	`deleteFilesInWhiteList()` Whether to delete files whose stack is in white list, used with white-list.
`boolean`	`displayNotification()` If need notification to notice block.
`boolean`	`filterNonConcernStack()` Filter stack without any in concern package, used with @{code concernPackages}.
`static BlockCanaryContext`	`get()`
`void`	`onBlock(android.content.Context context, BlockInfo blockInfo)` Block interceptor, developer may provide their own actions.
`int`	`provideBlockThreshold()` Config block threshold (in millis), dispatch over this duration is regarded as a BLOCK.
`android.content.Context`	`provideContext()` Provide application context.
`int`	`provideDumpInterval()` Thread stack dump interval, use when block happens, BlockCanary will dump on main thread stack according to current sample cycle.
`int`	`provideMonitorDuration()` Config monitor duration, after this time BlockCanary will stop, use with `BlockCanary`'s isMonitorDurationEnd
`java.lang.String`	`provideNetworkType()` Network type
`java.lang.String`	`providePath()` Path to save log, like "/blockcanary/", will save to sdcard if can.
`java.lang.String`	`provideQualifier()` Implement in your project.
`java.lang.String`	`provideUid()` Implement in your project.
`java.util.List<java.lang.String>`	`provideWhiteList()` Provide white list, entry in white list will not be shown in ui list.
`boolean`	`reportRecentOneMessage()` Default method will collect several messages when detect block what we not need
`boolean`	`stopWhenDebugging()` Whether to stop monitoring when in debug mode.
`void`	`upload(java.io.File zippedFile)` Implement in your project, bundled log files.
`boolean`	`zip(java.io.File[] src, java.io.File dest)` Implement in your project, bundle files into a zip file.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - BlockCanaryContext
```
public BlockCanaryContext()
```
- 方法详细资料
  - get
```
public static BlockCanaryContext get()
```
  - provideContext
```
public android.content.Context provideContext()
```
    Provide application context.
  - provideQualifier
```
public java.lang.String provideQualifier()
```
    Implement in your project.
    
    返回:
    
    Qualifier which can specify this installation, like version + flavor.
  - provideUid
```
public java.lang.String provideUid()
```
    Implement in your project.
    
    返回:
    
    user id
  - provideNetworkType
```
public java.lang.String provideNetworkType()
```
    Network type
    
    返回:
    
    String like 2G, 3G, 4G, wifi, etc.
  - provideMonitorDuration
```
public int provideMonitorDuration()
```
    Config monitor duration, after this time BlockCanary will stop, use with BlockCanary's isMonitorDurationEnd
    
    返回:
    
    monitor last duration (in hour)
  - provideBlockThreshold
```
public int provideBlockThreshold()
```
    Config block threshold (in millis), dispatch over this duration is regarded as a BLOCK. You may set it from performance of device.
    
    返回:
    
    threshold in mills
  - provideDumpInterval
```
public int provideDumpInterval()
```
    Thread stack dump interval, use when block happens, BlockCanary will dump on main thread stack according to current sample cycle.
    Because the implementation mechanism of Looper, real dump interval would be longer than the period specified here (especially when cpu is busier).
    
    返回:
    
    dump interval (in millis)
  - providePath
```
public java.lang.String providePath()
```
    Path to save log, like "/blockcanary/", will save to sdcard if can.
    
    返回:
    
    path of log files
  - displayNotification
```
public boolean displayNotification()
```
    If need notification to notice block.
    
    返回:
    
    true if need, else if not need.
  - zip
```
public boolean zip(java.io.File[] src,
                   java.io.File dest)
```
    Implement in your project, bundle files into a zip file.
    
    参数:
    
    src - files before compress
    
    dest - files compressed
    
    返回:
    
    true if compression is successful
  - upload
```
public void upload(java.io.File zippedFile)
```
    Implement in your project, bundled log files.
    
    参数:
    
    zippedFile - zipped file
  - concernPackages
```
public java.util.List<java.lang.String> concernPackages()
```
    Packages that developer concern, by default it uses process name, put high priority one in pre-order.
    
    返回:
    
    null if simply concern only package with process name.
  - filterNonConcernStack
```
public boolean filterNonConcernStack()
```
    Filter stack without any in concern package, used with @{code concernPackages}.
    
    返回:
    
    true if filter, false it not.
  - provideWhiteList
```
public java.util.List<java.lang.String> provideWhiteList()
```
    Provide white list, entry in white list will not be shown in ui list.
    
    返回:
    
    return null if you don't need white-list filter.
  - deleteFilesInWhiteList
```
public boolean deleteFilesInWhiteList()
```
    Whether to delete files whose stack is in white list, used with white-list.
    
    返回:
    
    true if delete, false it not.
  - onBlock
```
public void onBlock(android.content.Context context,
                    BlockInfo blockInfo)
```
    Block interceptor, developer may provide their own actions.
  - stopWhenDebugging
```
public boolean stopWhenDebugging()
```
    Whether to stop monitoring when in debug mode.
    
    返回:
    
    true if stop, false otherwise
  - reportRecentOneMessage
```
public boolean reportRecentOneMessage()
```
    Default method will collect several messages when detect block what we not need
    
    返回:
    
    true if you only need one message, false otherwise

类 BlockCanaryContext

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

BlockCanaryContext

方法详细资料

get

provideContext

provideQualifier

provideUid

provideNetworkType

provideMonitorDuration

provideBlockThreshold

provideDumpInterval

providePath

displayNotification

zip

upload

concernPackages

filterNonConcernStack

provideWhiteList

deleteFilesInWhiteList

onBlock

stopWhenDebugging

reportRecentOneMessage