Added in API level 9

Summary: Ctors | Methods | Inherited Methods

StrictMode.ThreadPolicy.Builder

---

Kotlin |Java

public static final class StrictMode.ThreadPolicy.Builder
extends Object

java.lang.Object
↳	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() Create a Builder that detects nothing and has no violations.
Builder(StrictMode.ThreadPolicy policy) Initialize a Builder from an existing ThreadPolicy.

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

Inherited methods

From class java.lang.Object Object clone() Creates and returns a copy of this object. boolean equals(Object obj) Indicates whether some other object is "equal to" this one. void finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. final Class<?> getClass() Returns the runtime class of this Object. int hashCode() Returns a hash code value for the object. final void notify() Wakes up a single thread that is waiting on this object's monitor. final void notifyAll() Wakes up all threads that are waiting on this object's monitor. String toString() Returns a string representation of the object. final void wait(long timeoutMillis, int nanos) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait(long timeoutMillis) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait() Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Public constructors

Builder

Added in API level 9

public Builder ()

Create 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

public Builder (StrictMode.ThreadPolicy policy)

Initialize a Builder from an existing ThreadPolicy.

Parameters
policy	StrictMode.ThreadPolicy

Public methods

build

Added in API level 9

public StrictMode.ThreadPolicy build ()

Construct the ThreadPolicy instance.

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

Returns
StrictMode.ThreadPolicy

detectAll

Added in API level 9

public StrictMode.ThreadPolicy.Builder detectAll ()

Detect everything that's potentially suspect.

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

Returns
StrictMode.ThreadPolicy.Builder	This value cannot be null.

detectCustomSlowCalls

Added in API level 11

public StrictMode.ThreadPolicy.Builder detectCustomSlowCalls ()

Enable detection of slow calls.

Returns
StrictMode.ThreadPolicy.Builder	This value cannot be null.

detectDiskReads

Added in API level 9

public StrictMode.ThreadPolicy.Builder detectDiskReads ()

Enable detection of disk reads.

Returns
StrictMode.ThreadPolicy.Builder	This value cannot be null.

detectDiskWrites

Added in API level 9

public StrictMode.ThreadPolicy.Builder detectDiskWrites ()

Enable detection of disk writes.

Returns
StrictMode.ThreadPolicy.Builder	This value cannot be null.

detectExplicitGc

Added in API level 34

public StrictMode.ThreadPolicy.Builder detectExplicitGc ()

Detect calls to Runtime#gc().

Returns
StrictMode.ThreadPolicy.Builder	This value cannot be null.

detectNetwork

Added in API level 9

public StrictMode.ThreadPolicy.Builder detectNetwork ()

Enable detection of network operations.

Returns
StrictMode.ThreadPolicy.Builder	This value cannot be null.

detectResourceMismatches

Added in API level 23

public StrictMode.ThreadPolicy.Builder detectResourceMismatches ()

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 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.

Returns
StrictMode.ThreadPolicy.Builder	This value cannot be null.

detectUnbufferedIo

Added in API level 26

public StrictMode.ThreadPolicy.Builder detectUnbufferedIo ()

Detect unbuffered input/output operations.

Returns
StrictMode.ThreadPolicy.Builder	This value cannot be null.

penaltyDeath

Added in API level 9

public StrictMode.ThreadPolicy.Builder penaltyDeath ()

Crash 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.

Returns
StrictMode.ThreadPolicy.Builder	This value cannot be null.

penaltyDeathOnNetwork

Added in API level 11

public StrictMode.ThreadPolicy.Builder penaltyDeathOnNetwork ()

Crash 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.

Returns
StrictMode.ThreadPolicy.Builder	This value cannot be null.

penaltyDialog

Added in API level 9

public StrictMode.ThreadPolicy.Builder penaltyDialog ()

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

Returns
StrictMode.ThreadPolicy.Builder	This value cannot be null.

penaltyDropBox

Added in API level 9

public StrictMode.ThreadPolicy.Builder penaltyDropBox ()

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

Returns
StrictMode.ThreadPolicy.Builder	This value cannot be null.

penaltyFlashScreen

Added in API level 11

public StrictMode.ThreadPolicy.Builder penaltyFlashScreen ()

Flash the screen during a violation.

Returns
StrictMode.ThreadPolicy.Builder	This value cannot be null.

penaltyListener

Added in API level 28

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

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

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

Returns
StrictMode.ThreadPolicy.Builder	This value cannot be null.

penaltyLog

Added in API level 9

public StrictMode.ThreadPolicy.Builder penaltyLog ()

Log detected violations to the system log.

Returns
StrictMode.ThreadPolicy.Builder	This value cannot be null.

permitAll

Added in API level 9

public StrictMode.ThreadPolicy.Builder permitAll ()

Disable the detection of everything.

Returns
StrictMode.ThreadPolicy.Builder	This value cannot be null.

permitCustomSlowCalls

Added in API level 11

public StrictMode.ThreadPolicy.Builder permitCustomSlowCalls ()

Disable detection of slow calls.

Returns
StrictMode.ThreadPolicy.Builder	This value cannot be null.

permitDiskReads

Added in API level 9

public StrictMode.ThreadPolicy.Builder permitDiskReads ()

Disable detection of disk reads.

Returns
StrictMode.ThreadPolicy.Builder	This value cannot be null.

permitDiskWrites

Added in API level 9

public StrictMode.ThreadPolicy.Builder permitDiskWrites ()

Disable detection of disk writes.

Returns
StrictMode.ThreadPolicy.Builder	This value cannot be null.

permitExplicitGc

Added in API level 34

public StrictMode.ThreadPolicy.Builder permitExplicitGc ()

Disable detection of calls to Runtime#gc().

Returns
StrictMode.ThreadPolicy.Builder	This value cannot be null.

permitNetwork

Added in API level 9

public StrictMode.ThreadPolicy.Builder permitNetwork ()

Disable detection of network operations.

Returns
StrictMode.ThreadPolicy.Builder	This value cannot be null.

permitResourceMismatches

Added in API level 23

public StrictMode.ThreadPolicy.Builder permitResourceMismatches ()

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

Returns
StrictMode.ThreadPolicy.Builder	This value cannot be null.

permitUnbufferedIo

Added in API level 26

public StrictMode.ThreadPolicy.Builder permitUnbufferedIo ()

Disable detection of unbuffered input/output operations.

Returns
StrictMode.ThreadPolicy.Builder	This value cannot be null.