public class

TracingConfig.Builder

extends java.lang.Object

 java.lang.Object

↳androidx.webkit.TracingConfig.Builder

Overview

Builder used to create TracingConfig objects.

Examples:

   // Create a configuration with default options: TracingConfig.CATEGORIES_NONE,
   // TracingConfig.RECORD_CONTINUOUSLY.
   new TracingConfig.Builder().build()

   // Record trace events from the "web developer" predefined category sets.
   // Uses a ring buffer (the default TracingConfig.RECORD_CONTINUOUSLY mode) for
   // internal storage during tracing.
   new TracingConfig.Builder().addCategories(CATEGORIES_WEB_DEVELOPER).build()

   // Record trace events from the "rendering" and "input latency" predefined
   // category sets.
   new TracingConfig.Builder().addCategories(CATEGORIES_RENDERING,
                                     CATEGORIES_INPUT_LATENCY).build()

   // Record only the trace events from the "browser" category.
   new TracingConfig.Builder().addCategories("browser").build()

   // Record only the trace events matching the "blink*" and "renderer*" patterns
   // (e.g. "blink.animations", "renderer_host" and "renderer.scheduler" categories).
   new TracingConfig.Builder().addCategories("blink*","renderer*").build()

   // Record events from the "web developer" predefined category set and events from
   // the "disabled-by-default-v8.gc" category to understand where garbage collection
   // is being triggered. Uses a limited size buffer for internal storage during tracing.
   new TracingConfig.Builder().addCategories(CATEGORIES_WEB_DEVELOPER)
                              .addCategories("disabled-by-default-v8.gc")
                              .setTracingMode(RECORD_UNTIL_FULL).build()
 

Summary

Constructors
publicBuilder()

Default constructor for Builder.

Methods
public TracingConfig.BuilderaddCategories(java.util.Collection<java.lang.String> categories)

Adds custom categories to be included in trace output.

public TracingConfig.BuilderaddCategories(int[] predefinedCategories[])

Adds predefined sets of categories to be included in the trace output.

public TracingConfig.BuilderaddCategories(java.lang.String categories[])

Adds custom categories to be included in trace output.

public TracingConfigbuild()

Build TracingConfig using the current settings.

public TracingConfig.BuildersetTracingMode(int tracingMode)

Sets the tracing mode for this configuration.

from java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructors

public Builder()

Default constructor for Builder.

Methods

public TracingConfig build()

Build TracingConfig using the current settings.

Returns:

The TracingConfig with the current settings.

public TracingConfig.Builder addCategories(int[] predefinedCategories[])

Adds predefined sets of categories to be included in the trace output. A predefined category set can be one of TracingConfig.CATEGORIES_NONE, TracingConfig.CATEGORIES_ALL, TracingConfig.CATEGORIES_ANDROID_WEBVIEW, TracingConfig.CATEGORIES_WEB_DEVELOPER, TracingConfig.CATEGORIES_INPUT_LATENCY, TracingConfig.CATEGORIES_RENDERING, TracingConfig.CATEGORIES_JAVASCRIPT_AND_RENDERING or TracingConfig.CATEGORIES_FRAME_VIEWER.

Parameters:

predefinedCategories: A list or bitmask of predefined category sets.

Returns:

The builder to facilitate chaining.

public TracingConfig.Builder addCategories(java.lang.String categories[])

Adds custom categories to be included in trace output. Note that the categories are defined by the currently-in-use version of WebView. They live in chromium code and are not part of the Android API. See chromium documentation on tracing for more details.

Parameters:

categories: A list of category patterns. A category pattern can contain wildcards, e.g. "blink*" or full category name e.g. "renderer.scheduler".

Returns:

The builder to facilitate chaining.

public TracingConfig.Builder addCategories(java.util.Collection<java.lang.String> categories)

Adds custom categories to be included in trace output. Same as TracingConfig.Builder.addCategories(String...) but allows to pass a Collection as a parameter.

Parameters:

categories: A list of category patterns.

Returns:

The builder to facilitate chaining.

public TracingConfig.Builder setTracingMode(int tracingMode)

Sets the tracing mode for this configuration. When tracingMode is not set explicitly, the default is .

Parameters:

tracingMode: The tracing mode to use, one of TracingConfig.RECORD_UNTIL_FULL or TracingConfig.RECORD_CONTINUOUSLY.

Returns:

The builder to facilitate chaining.