bindInstance static method

void bindInstance(SuperuserInterface? suInterface)

Attach specified suInterface as data source of superuser property.

If suInterface is null, it binds platform specified SuperuserInterface automatically if the platform is either Windows, macOS or Linux.

It is possible (but rarely) to attach customized SuperuserPlatform if necessary.

When suInterface is SuperuserPlatform (i.e WindowsSuperuser or UnixSuperuser), it cannot be constructed when testing as well as comply it's target platform that UnsupportedError will be thrown if violated. MockSuperuser can only be assigned when running in debug mode or during test that UnsupportedError also will be thrown if unsatified. In another word, only running program in debug mode can freely attach whatever SuperuserInterface implementation is used.

Implementation

static void bindInstance(SuperuserInterface? suInterface) {
  if (suInterface != null) {
    _instance = suInterface;
    return;
  }

  // Denote null interface as uses default implementation.
  if (Platform.isWindows) {
    _instance = WindowsSuperuser();
  } else if (Platform.isMacOS || Platform.isLinux) {
    _instance = UnixSuperuser();
  } else {
    throw UnimplementedError(
      "No default implementation available for this platform.",
    );
  }
}