{% setvar book_path %}/reference/androidx/_book.yaml{% endsetvar %} {% include "_shared/_reference-head-tags.html" %}

ProviderTestRule.Builder

public class ProviderTestRule.Builder

A Builder to ease ProviderTestRule creation. Users can input one or more ContentProviders and their corresponding authority for tests. It also allows to specify the prefix to use when renaming test files for isolation by setPrefix. If the ContentProvider under test is implemented based on SQLiteDatabase, users can also pass in database file to restore or database commands to run before tests.

Summary

Public constructors
<T extends ContentProvider> Builder(
    @NonNull Class<@NonNull T> providerClass,
    @NonNull String providerAuth
)

The basic builder to use when creating a ProviderTestRule, which allows to specify one ContentProvider and the corresponding authority for tests.

Public methods
@NonNull ProviderTestRule.Builder
<T extends ContentProvider> addProvider(
    @NonNull Class<@NonNull T> providerClass,
    @NonNull String providerAuth
)

Allows to add additional ContentProvider and the corresponding authority for testing.
@NonNull ProviderTestRule
@NonNull ProviderTestRule.Builder
setDatabaseCommands(
    @NonNull String dbName,
    @NonNull Array<@NonNull String> dbCmds
)

Allows to pass in specific SQL commands to run against the database with a given name.
@NonNull ProviderTestRule.Builder

Allows to pass in a file containing commands to run against the database with a given name.
@NonNull ProviderTestRule.Builder
setDatabaseFile(@NonNull String dbName, @NonNull File dbDataFile)

Allows to pass in a SQLite database file containing the intended initial data to restore.
@NonNull ProviderTestRule.Builder

Enables users to specify the prefix to use when renaming test files for isolation.

Public constructors

Builder

public <T extends ContentProvider> Builder(
    @NonNull Class<@NonNull T> providerClass,
    @NonNull String providerAuth
)

The basic builder to use when creating a ProviderTestRule, which allows to specify one ContentProvider and the corresponding authority for tests.

Parameters
@NonNull Class<@NonNull T> providerClass

The class of ContentProvider under test.
@NonNull String providerAuth

The authority defined for ContentProvider under test.

Public methods

addProvider

@NonNull
public ProviderTestRule.Builder <T extends ContentProvider> addProvider(
    @NonNull Class<@NonNull T> providerClass,
    @NonNull String providerAuth
)

Allows to add additional ContentProvider and the corresponding authority for testing. Similarly, setDatabaseFile, setDatabaseCommands, , and runDatabaseCommands can be used for this ContentProvider.

Parameters
@NonNull Class<@NonNull T> providerClass

The class of the added ContentProvider under test.
@NonNull String providerAuth

The authority defined for the added ContentProvider under test.

build

@NonNull
public ProviderTestRule build()

setDatabaseCommands

@NonNull
public ProviderTestRule.Builder setDatabaseCommands(
    @NonNull String dbName,
    @NonNull Array<@NonNull String> dbCmds
)

Allows to pass in specific SQL commands to run against the database with a given name.

Note: The passed in commands are executed before any sql commands execution in SQLiteOpenHelper's onCreate method defined in ContentProvider under test, also before executing commands, if any, passed in via setDatabaseCommandsFile, but after restoring the database file, if any, passed in via setDatabaseFile.

Parameters
@NonNull String dbName

The name of the underlying database used by the ContentProvider under test.
@NonNull Array<@NonNull String> dbCmds

The SQL commands to run. Each command will be passed to execSQL to execute.

setDatabaseCommandsFile

@NonNull
public ProviderTestRule.Builder setDatabaseCommandsFile(@NonNull String dbName, @NonNull File dbCmdFile)

Allows to pass in a file containing commands to run against the database with a given name.

Note: Commands in the file are executed before any sql commands execution in SQLiteOpenHelper's onCreate method defined in ContentProvider under test, but after restoring the database file, if any, passed in via setDatabaseFile and executing commands, if any, passed in via setDatabaseCommands.

Parameters
@NonNull String dbName

The name of the underlying database used by the ContentProvider under test.
@NonNull File dbCmdFile

The file that contains line separated database commands to run. Each line will be treated as a separate command and passed to execSQL to execute.

setDatabaseFile

@NonNull
public ProviderTestRule.Builder setDatabaseFile(@NonNull String dbName, @NonNull File dbDataFile)

Allows to pass in a SQLite database file containing the intended initial data to restore.

Note: Restoring the database from the file are executed before any sql commands execution in SQLiteOpenHelper's onCreate method defined in ContentProvider under test, also before running the database commands, if any, passed in via setDatabaseCommands and setDatabaseCommandsFile.

In the case of the database file with prefixed name already exists, the database restoration will overwrite existing file.

Parameters
@NonNull String dbName

The name of the underlying database used by the ContentProvider under test.
@NonNull File dbDataFile

The SQLite database file that contains the data to restore.

setPrefix

@NonNull
public ProviderTestRule.Builder setPrefix(@NonNull String prefix)

Enables users to specify the prefix to use when renaming test files for isolation. If not used, this rule will use "#DEFAULT_PREFIX" by default.

Parameters
@NonNull String prefix

The non-empty prefix to append to test files.