Shared Preferences Platform Interface - Dart
Uploaded by
İlter Engin KIZILGÜNShared Preferences Platform Interface - Dart
Uploaded by
İlter Engin KIZILGÜN// Copyright 2017 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
import 'dart:async';
import 'package:meta/meta.dart';
import 'method_channel_shared_preferences.dart';
/// The interface that implementations of shared_preferences must implement.
///
/// Platform implementations should extend this class rather than implement it a
s `shared_preferences`
/// does not consider newly added methods to be breaking changes. Extending this
class
/// (using `extends`) ensures that the subclass will get the default implementat
ion, while
/// platform implementations that `implements` this interface will be broken by
newly added
/// [SharedPreferencesStorePlatform] methods.
abstract class SharedPreferencesStorePlatform {
/// The default instance of [SharedPreferencesStorePlatform] to use.
///
/// Defaults to [MethodChannelSharedPreferencesStore].
static SharedPreferencesStorePlatform get instance => _instance;
/// Platform-specific plugins should set this with their own platform-specific
/// class that extends [SharedPreferencesStorePlatform] when they register the
mselves.
static set instance(SharedPreferencesStorePlatform value) {
if (!value.isMock) {
try {
value._verifyProvidesDefaultImplementations();
} on NoSuchMethodError catch (_) {
throw AssertionError(
'Platform interfaces must not be implemented with `implements`');
}
}
_instance = value;
}
static SharedPreferencesStorePlatform _instance =
MethodChannelSharedPreferencesStore();
/// Only mock implementations should set this to true.
///
/// Mockito mocks are implementing this class with `implements` which is forbi
dden for anything
/// other than mocks (see class docs). This property provides a backdoor for m
ockito mocks to
/// skip the verification that the class isn't implemented with `implements`.
@visibleForTesting
bool get isMock => false;
/// Removes the value associated with the [key].
Future<bool> remove(String key);
/// Stores the [value] associated with the [key].
///
/// The [valueType] must match the type of [value] as follows:
///
/// * Value type "Bool" must be passed if the value is of type `bool`.
/// * Value type "Double" must be passed if the value is of type `double`.
/// * Value type "Int" must be passed if the value is of type `int`.
/// * Value type "String" must be passed if the value is of type `String`.
/// * Value type "StringList" must be passed if the value is of type `List<Str
ing>`.
Future<bool> setValue(String valueType, String key, Object value);
/// Removes all keys and values in the store.
Future<bool> clear();
/// Returns all key/value pairs persisted in this store.
Future<Map<String, Object>> getAll();
// This method makes sure that SharedPreferencesStorePlatform isn't implemente
d with `implements`.
//
// See class doc for more details on why implementing this class is forbidden.
//
// This private method is called by the instance setter, which fails if the cl
ass is
// implemented with `implements`.
void _verifyProvidesDefaultImplementations() {}
}
/// Stores data in memory.
///
/// Data does not persist across application restarts. This is useful in unit-te
sts.
class InMemorySharedPreferencesStore extends SharedPreferencesStorePlatform {
/// Instantiates an empty in-memory preferences store.
InMemorySharedPreferencesStore.empty() : _data = <String, Object>{};
/// Instantiates an in-memory preferences store containing a copy of [data].
InMemorySharedPreferencesStore.withData(Map<String, Object> data)
: _data = Map<String, Object>.from(data);
final Map<String, Object> _data;
@override
Future<bool> clear() async {
_data.clear();
return true;
}
@override
Future<Map<String, Object>> getAll() async {
return Map<String, Object>.from(_data);
}
@override
Future<bool> remove(String key) async {
_data.remove(key);
return true;
}
@override
Future<bool> setValue(String valueType, String key, Object value) async {
_data[key] = value;
return true;
}
}
