Insight.Category

Artifact: androidx.benchmark:benchmark-traceprocessor

Added in 1.4.1

Kotlin |Java

@ExperimentalInsightApi
public final class Insight.Category

Category represents general expectations that have been violated by an insight - e.g. JIT shouldn't take longer than XX ms, or trampoline activities shouldn't be used.

Every Insight that shares the same conceptual category must share an equal Category so that macrobenchmark can group them when summarizing observed patterns across multiple iterations.

In Studio versions supporting web links, will produce an output like the following:

[JIT compiled methods](https://d.android.com/test#JIT_COMPILED_METHODS) (expected: < 65 count)

In the above example:

title is "JIT compiled methods"
titleUrl is "https://d.android.com/test#JIT_COMPILED_METHODS"
postTitleLabel is " (expected: < 65 count)"

In Studio versions not supporting web links, titleUrl is ignored.

Summary

Public constructors
`Category( @NonNull String title, String titleUrl, @NonNull String postTitleLabel )`

Public methods
`boolean`	`equals(Object other)`
`final @NonNull String`	`getPostTitleLabel()` Suffix after the title, generally specifying expected values.
`final @NonNull String`	`getTitle()` Title of the Insight category, for example "JIT compiled methods"
`final String`	`getTitleUrl()` Optional web URL to explain the category of problem.
`int`	`hashCode()`
`@NonNull String`	`toString()`

Public constructors

Public methods

equals

public boolean equals(Object other)

getPostTitleLabel

Added in 1.4.1

public final @NonNull String getPostTitleLabel()

Suffix after the title, generally specifying expected values.

For example, " (expected: < 65 count)"

getTitle

Added in 1.4.1

public final @NonNull String getTitle()

Title of the Insight category, for example "JIT compiled methods"

getTitleUrl

Added in 1.4.1

public final String getTitleUrl()

Optional web URL to explain the category of problem.

If non-null, generally title should be linked to this URL.

hashCode

public int hashCode()

toString

public @NonNull String toString()