Effective in 2026, to align with our trunk stable development model and ensure platform stability for the ecosystem, we will publish source code to AOSP in Q2 and Q4. For building and contributing to AOSP, we recommend utilizing android-latest-release instead of aosp-main. The android-latest-release manifest branch will always reference the most recent release pushed to AOSP. For more information, see Changes to AOSP.

BaseSwitchUserTargetPreparer

public abstract class BaseSwitchUserTargetPreparer
extends BaseTargetPreparer

java.lang.Object
↳	com.android.tradefed.targetprep.BaseTargetPreparer
	↳	com.android.tradefed.targetprep.BaseSwitchUserTargetPreparer

Known direct subclasses

SwitchUserTargetPreparer

SwitchUserTargetPreparer Default implementation of BaseSwitchUserTargetPreparer - see that class' javadoc for more info.

A ITargetPreparer that switches to the specified user type in setUp. By default it remains in the current user, and no switching is performed.

Tries to restore device user state by switching back to the pre-execution current user.

After setUp(TestInformation), it sets the PROPERTY_PREPARED_USER property with the value of the current user.

Summary

Constants
`String`	`PROPERTY_PREPARED_USER` Name of the `TestInfo` `property` key that stores the id of the current user of the device after the target preparation.

Public constructors
`BaseSwitchUserTargetPreparer()`

Public methods
`final void`	`setUp(ITestDevice device, IBuildInfo buildInfo)`
`final void`	`tearDown(ITestDevice device, IBuildInfo buildInfo, Throwable e)`

Protected methods
`final Integer`	`getPreparedUserId()`
`final void`	`setPreparedUser(TestInformation testInformation, Integer userId)`

Constants

PROPERTY_PREPARED_USER

public static final String PROPERTY_PREPARED_USER

Name of the TestInfo property key that stores the id of the current user of the device after the target preparation.

For example, if the current user before the preparer was triggered was 42 and the preparer switched to 0, then the value of the property will be "0".

Note: the property is not set if the user switch failed, and it's removed at the end (after tearDown(TestInformation,Throwable)).

Constant Value: "com.android.tradefed.targetprep.SwitchUserTargetPreparer.preparedUser"

Public constructors

BaseSwitchUserTargetPreparer

public BaseSwitchUserTargetPreparer ()

Public methods

setUp

public final void setUp (ITestDevice device, 
                IBuildInfo buildInfo)

Parameters
`device`	`ITestDevice`
`buildInfo`	`IBuildInfo`

Throws
`BuildError`
`DeviceNotAvailableException`
`TargetSetupError`

tearDown

public final void tearDown (ITestDevice device, 
                IBuildInfo buildInfo, 
                Throwable e)

Parameters
`device`	`ITestDevice`
`buildInfo`	`IBuildInfo`
`e`	`Throwable`

Throws
`DeviceNotAvailableException`

Protected methods

getPreparedUserId

protected final Integer getPreparedUserId ()

Returns
`Integer`

setPreparedUser

protected final void setPreparedUser (TestInformation testInformation, 
                Integer userId)

Parameters
`testInformation`	`TestInformation`
`userId`	`Integer`