base/prefs/pref_service_builder.h

   1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef BASE_PREFS_PREF_SERVICE_BUILDER_H_
   6 #define BASE_PREFS_PREF_SERVICE_BUILDER_H_
   7
   8 #include "base/basictypes.h"
   9 #include "base/callback.h"
  10 #include "base/memory/ref_counted.h"
  11 #include "base/prefs/base_prefs_export.h"
  12 #include "base/prefs/persistent_pref_store.h"
  13 #include "base/prefs/pref_registry.h"
  14 #include "base/prefs/pref_store.h"
  15
  16 class PrefService;
  17
  18 namespace base {
  19 class FilePath;
  20 class SequencedTaskRunner;
  21 }
  22
  23 // A class that allows convenient building of PrefService.
  24 class BASE_PREFS_EXPORT PrefServiceBuilder {
  25  public:
  26   PrefServiceBuilder();
  27   virtual ~PrefServiceBuilder();
  28
  29   // Functions for setting the various parameters of the PrefService to build.
  30   // These take ownership of the |store| parameter.
  31   PrefServiceBuilder& WithManagedPrefs(PrefStore* store);
  32   PrefServiceBuilder& WithExtensionPrefs(PrefStore* store);
  33   PrefServiceBuilder& WithCommandLinePrefs(PrefStore* store);
  34   PrefServiceBuilder& WithUserPrefs(PersistentPrefStore* store);
  35   PrefServiceBuilder& WithRecommendedPrefs(PrefStore* store);
  36
  37   // Sets up error callback for the PrefService.  A do-nothing default
  38   // is provided if this is not called.
  39   PrefServiceBuilder& WithReadErrorCallback(
  40       const base::Callback<void(PersistentPrefStore::PrefReadError)>&
  41           read_error_callback);
  42
  43   // Specifies to use an actual file-backed user pref store.
  44   PrefServiceBuilder& WithUserFilePrefs(
  45       const base::FilePath& prefs_file,
  46       base::SequencedTaskRunner* task_runner);
  47
  48   PrefServiceBuilder& WithAsync(bool async);
  49
  50   // Creates a PrefService object initialized with the parameters from
  51   // this builder.
  52   virtual PrefService* Create(PrefRegistry* registry);
  53
  54  protected:
  55   virtual void ResetDefaultState();
  56
  57   scoped_refptr<PrefStore> managed_prefs_;
  58   scoped_refptr<PrefStore> extension_prefs_;
  59   scoped_refptr<PrefStore> command_line_prefs_;
  60   scoped_refptr<PersistentPrefStore> user_prefs_;
  61   scoped_refptr<PrefStore> recommended_prefs_;
  62
  63   base::Callback<void(PersistentPrefStore::PrefReadError)> read_error_callback_;
  64
  65   // Defaults to false.
  66   bool async_;
  67
  68  private:
  69   DISALLOW_COPY_AND_ASSIGN(PrefServiceBuilder);
  70 };
  71
  72 #endif  // BASE_PREFS_PREF_SERVICE_BUILDER_H_