Builder

Kotlin |Java

class Builder

kotlin.Any
↳	android.os.StrictMode.ThreadPolicy.Builder

Creates ThreadPolicy instances. Methods whose names start with detect specify what problems we should look for. Methods whose names start with penalty specify what we should do when we detect a problem.

You can call as many detect and penalty methods as you like. Currently order is insignificant: all penalties apply to all detected problems.

For example, detect everything and log anything that's found:

StrictMode.ThreadPolicy policy = new StrictMode.ThreadPolicy.Builder()
      .detectAll()
      .penaltyLog()
      .build();
  StrictMode.setThreadPolicy(policy);

Summary

Public constructors
`Builder()` Creates a Builder that detects nothing and has no violations.
`Builder(policy: StrictMode.ThreadPolicy!)` Initializes a Builder from an existing ThreadPolicy.

Public methods
StrictMode.ThreadPolicy!	`build()` Constructs the ThreadPolicy instance.
StrictMode.ThreadPolicy.Builder	`detectAll()` Detects everything that's potentially suspect.
StrictMode.ThreadPolicy.Builder	`detectCustomSlowCalls()` Enables detection of slow calls.
StrictMode.ThreadPolicy.Builder	`detectDiskReads()` Enables detection of disk reads.
StrictMode.ThreadPolicy.Builder	`detectDiskWrites()` Enables detection of disk writes.
StrictMode.ThreadPolicy.Builder	`detectExplicitGc()` Detects calls to `Runtime.gc()`.
StrictMode.ThreadPolicy.Builder	`detectNetwork()` Enables detection of network operations.
StrictMode.ThreadPolicy.Builder	`detectResourceMismatches()` Enables detection of mismatches between defined resource types and getter calls.
StrictMode.ThreadPolicy.Builder	`detectUnbufferedIo()` Detects unbuffered input/output operations.
StrictMode.ThreadPolicy.Builder	`penaltyDeath()` Crashes the whole process on violation.
StrictMode.ThreadPolicy.Builder	`penaltyDeathOnNetwork()` Crashes the whole process on any network usage.
StrictMode.ThreadPolicy.Builder	`penaltyDialog()` Shows an annoying dialog to the developer on detected violations, rate-limited to be only a little annoying.
StrictMode.ThreadPolicy.Builder	`penaltyDropBox()` Enables detected violations log a stacktrace and timing data to the on policy violation.
StrictMode.ThreadPolicy.Builder	`penaltyFlashScreen()` Flashes the screen during a violation.
StrictMode.ThreadPolicy.Builder	`penaltyListener(executor: Executor, listener: StrictMode.OnThreadViolationListener)` Calls #`OnThreadViolationListener.onThreadViolation(Violation)` on specified executor every violation.
StrictMode.ThreadPolicy.Builder	`penaltyLog()` Logs detected violations to the system log.
StrictMode.ThreadPolicy.Builder	`permitAll()` Disables the detection of everything.
StrictMode.ThreadPolicy.Builder	`permitCustomSlowCalls()` Disables detection of slow calls.
StrictMode.ThreadPolicy.Builder	`permitDiskReads()` Disables detection of disk reads.
StrictMode.ThreadPolicy.Builder	`permitDiskWrites()` Disables detection of disk writes.
StrictMode.ThreadPolicy.Builder	`permitExplicitGc()` Disables detection of calls to `Runtime.gc()`.
StrictMode.ThreadPolicy.Builder	`permitNetwork()` Disables detection of network operations.
StrictMode.ThreadPolicy.Builder	`permitResourceMismatches()` Disables detection of mismatches between defined resource types and getter calls.
StrictMode.ThreadPolicy.Builder	`permitUnbufferedIo()` Disables detection of unbuffered input/output operations.

Public constructors

Builder

Added in API level 9

Builder()

Creates a Builder that detects nothing and has no violations. (but note that build will default to enabling penaltyLog if no other penalties are specified)

Builder

Added in API level 9

Builder(policy: StrictMode.ThreadPolicy!)

Initializes a Builder from an existing ThreadPolicy.

Public methods

build

Added in API level 9

fun build(): StrictMode.ThreadPolicy!

Constructs the ThreadPolicy instance.

Note: if no penalties are enabled before calling build, penaltyLog is implicitly set.

detectAll

Added in API level 9

fun detectAll(): StrictMode.ThreadPolicy.Builder

Detects everything that's potentially suspect.

As of the Gingerbread release this includes network and disk operations but will likely expand in future releases.

Return
`StrictMode.ThreadPolicy.Builder`	This value cannot be `null`.

detectCustomSlowCalls

Added in API level 11

fun detectCustomSlowCalls(): StrictMode.ThreadPolicy.Builder

Enables detection of slow calls.

Return
`StrictMode.ThreadPolicy.Builder`	This value cannot be `null`.

detectDiskReads

Added in API level 9

fun detectDiskReads(): StrictMode.ThreadPolicy.Builder

Enables detection of disk reads.

Return
`StrictMode.ThreadPolicy.Builder`	This value cannot be `null`.

detectDiskWrites

Added in API level 9

fun detectDiskWrites(): StrictMode.ThreadPolicy.Builder

Enables detection of disk writes.

Return
`StrictMode.ThreadPolicy.Builder`	This value cannot be `null`.

detectExplicitGc

Added in API level 34

fun detectExplicitGc(): StrictMode.ThreadPolicy.Builder

Detects calls to Runtime.gc().

Return
`StrictMode.ThreadPolicy.Builder`	This value cannot be `null`.

detectNetwork

Added in API level 9

fun detectNetwork(): StrictMode.ThreadPolicy.Builder

Enables detection of network operations.

Return
`StrictMode.ThreadPolicy.Builder`	This value cannot be `null`.

detectResourceMismatches

Added in API level 23

fun detectResourceMismatches(): StrictMode.ThreadPolicy.Builder

Enables detection of mismatches between defined resource types and getter calls.

This helps detect accidental type mismatches and potentially expensive type conversions when obtaining typed resources.

For example, a strict mode violation would be thrown when calling android.content.res.TypedArray#getInt(int, int) on an index that contains a String-type resource. If the string value can be parsed as an integer, this method call will return a value without crashing; however, the developer should format the resource as an integer to avoid unnecessary type conversion.

Return
`StrictMode.ThreadPolicy.Builder`	This value cannot be `null`.

detectUnbufferedIo

Added in API level 26

fun detectUnbufferedIo(): StrictMode.ThreadPolicy.Builder

Detects unbuffered input/output operations.

Return
`StrictMode.ThreadPolicy.Builder`	This value cannot be `null`.

penaltyDeath

Added in API level 9

fun penaltyDeath(): StrictMode.ThreadPolicy.Builder

Crashes the whole process on violation. This penalty runs at the end of all enabled penalties so you'll still get see logging or other violations before the process dies.

Unlike penaltyDeathOnNetwork, this applies to disk reads, disk writes, and network usage if their corresponding detect flags are set.

Return
`StrictMode.ThreadPolicy.Builder`	This value cannot be `null`.

penaltyDeathOnNetwork

Added in API level 11

fun penaltyDeathOnNetwork(): StrictMode.ThreadPolicy.Builder

Crashes the whole process on any network usage. Unlike penaltyDeath, this penalty runs before anything else. You must still have called detectNetwork to enable this.

In the Honeycomb or later SDKs, this is on by default.

Return
`StrictMode.ThreadPolicy.Builder`	This value cannot be `null`.

penaltyDialog

Added in API level 9

fun penaltyDialog(): StrictMode.ThreadPolicy.Builder

Shows an annoying dialog to the developer on detected violations, rate-limited to be only a little annoying.

Return
`StrictMode.ThreadPolicy.Builder`	This value cannot be `null`.

penaltyDropBox

Added in API level 9

fun penaltyDropBox(): StrictMode.ThreadPolicy.Builder

Enables detected violations log a stacktrace and timing data to the on policy violation. Intended mostly for platform integrators doing beta user field data collection.

Return
`StrictMode.ThreadPolicy.Builder`	This value cannot be `null`.

penaltyFlashScreen

Added in API level 11

fun penaltyFlashScreen(): StrictMode.ThreadPolicy.Builder

Flashes the screen during a violation.

Return
`StrictMode.ThreadPolicy.Builder`	This value cannot be `null`.

penaltyListener

Added in API level 28

fun penaltyListener(
    executor: Executor, 
    listener: StrictMode.OnThreadViolationListener
): StrictMode.ThreadPolicy.Builder

Calls #OnThreadViolationListener.onThreadViolation(Violation) on specified executor every violation.

Parameters
`executor`	Executor: This value cannot be `null`.
`listener`	StrictMode.OnThreadViolationListener: This value cannot be `null`.

Return
`StrictMode.ThreadPolicy.Builder`	This value cannot be `null`.

penaltyLog

Added in API level 9

fun penaltyLog(): StrictMode.ThreadPolicy.Builder

Logs detected violations to the system log.

Return
`StrictMode.ThreadPolicy.Builder`	This value cannot be `null`.

permitAll

Added in API level 9

fun permitAll(): StrictMode.ThreadPolicy.Builder

Disables the detection of everything.

Return
`StrictMode.ThreadPolicy.Builder`	This value cannot be `null`.

permitCustomSlowCalls

Added in API level 11

fun permitCustomSlowCalls(): StrictMode.ThreadPolicy.Builder

Disables detection of slow calls.

Return
`StrictMode.ThreadPolicy.Builder`	This value cannot be `null`.

permitDiskReads

Added in API level 9

fun permitDiskReads(): StrictMode.ThreadPolicy.Builder

Disables detection of disk reads.

Return
`StrictMode.ThreadPolicy.Builder`	This value cannot be `null`.

permitDiskWrites

Added in API level 9

fun permitDiskWrites(): StrictMode.ThreadPolicy.Builder

Disables detection of disk writes.

Return
`StrictMode.ThreadPolicy.Builder`	This value cannot be `null`.

permitExplicitGc

Added in API level 34

fun permitExplicitGc(): StrictMode.ThreadPolicy.Builder

Disables detection of calls to Runtime.gc().

Return
`StrictMode.ThreadPolicy.Builder`	This value cannot be `null`.

permitNetwork

Added in API level 9

fun permitNetwork(): StrictMode.ThreadPolicy.Builder

Disables detection of network operations.

Return
`StrictMode.ThreadPolicy.Builder`	This value cannot be `null`.

permitResourceMismatches

Added in API level 23

fun permitResourceMismatches(): StrictMode.ThreadPolicy.Builder

Disables detection of mismatches between defined resource types and getter calls.

Return
`StrictMode.ThreadPolicy.Builder`	This value cannot be `null`.

permitUnbufferedIo

Added in API level 26

fun permitUnbufferedIo(): StrictMode.ThreadPolicy.Builder

Disables detection of unbuffered input/output operations.

Return
`StrictMode.ThreadPolicy.Builder`	This value cannot be `null`.