base/prefs/pref_service_builder.h

// Copyright (c) 2012 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.

#ifndef BASE_PREFS_PREF_SERVICE_BUILDER_H_
#define BASE_PREFS_PREF_SERVICE_BUILDER_H_

#include "base/basictypes.h"
#include "base/callback.h"
#include "base/memory/ref_counted.h"
#include "base/prefs/base_prefs_export.h"
#include "base/prefs/persistent_pref_store.h"
#include "base/prefs/pref_registry.h"
#include "base/prefs/pref_store.h"

class PrefService;

namespace base {
class FilePath;
class SequencedTaskRunner;
}

// A class that allows convenient building of PrefService.
class BASE_PREFS_EXPORT PrefServiceBuilder {
 public:
  PrefServiceBuilder();
  virtual ~PrefServiceBuilder();

  // Functions for setting the various parameters of the PrefService to build.
  // These take ownership of the |store| parameter.
  PrefServiceBuilder& WithManagedPrefs(PrefStore* store);
  PrefServiceBuilder& WithSupervisedUserPrefs(PrefStore* store);
  PrefServiceBuilder& WithExtensionPrefs(PrefStore* store);
  PrefServiceBuilder& WithCommandLinePrefs(PrefStore* store);
  PrefServiceBuilder& WithUserPrefs(PersistentPrefStore* store);
  PrefServiceBuilder& WithRecommendedPrefs(PrefStore* store);

  // Sets up error callback for the PrefService.  A do-nothing default
  // is provided if this is not called.
  PrefServiceBuilder& WithReadErrorCallback(
      const base::Callback<void(PersistentPrefStore::PrefReadError)>&
          read_error_callback);

  // Specifies to use an actual file-backed user pref store.
  PrefServiceBuilder& WithUserFilePrefs(
      const base::FilePath& prefs_file,
      base::SequencedTaskRunner* task_runner);

  PrefServiceBuilder& WithAsync(bool async);

  // Creates a PrefService object initialized with the parameters from
  // this builder.
  virtual PrefService* Create(PrefRegistry* registry);

 protected:
  virtual void ResetDefaultState();

  scoped_refptr<PrefStore> managed_prefs_;
  scoped_refptr<PrefStore> supervised_user_prefs_;
  scoped_refptr<PrefStore> extension_prefs_;
  scoped_refptr<PrefStore> command_line_prefs_;
  scoped_refptr<PersistentPrefStore> user_prefs_;
  scoped_refptr<PrefStore> recommended_prefs_;

  base::Callback<void(PersistentPrefStore::PrefReadError)> read_error_callback_;

  // Defaults to false.
  bool async_;

 private:
  DISALLOW_COPY_AND_ASSIGN(PrefServiceBuilder);
};

#endif  // BASE_PREFS_PREF_SERVICE_BUILDER_H_