Refactor BrowsingDataRemover creation for clarity.

chrome/browser/browsing_data/browsing_data_remover.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 CHROME_BROWSER_BROWSING_DATA_BROWSING_DATA_REMOVER_H_
 #define CHROME_BROWSER_BROWSING_DATA_BROWSING_DATA_REMOVER_H_
 
 #include <set>
 
 #include "base/gtest_prod_util.h"
@@ skipping 98 matching lines @@
   // Observer is notified when the removal is done. Done means keywords have
   // been deleted, cache cleared and all other tasks scheduled.
   class Observer {
    public:
     virtual void OnBrowsingDataRemoverDone() = 0;
 
    protected:
     virtual ~Observer() {}
   };
 
-  // Creates a BrowsingDataRemover to remove browser data from the specified
-  // profile in the specified time range. Use Remove to initiate the removal.
-  BrowsingDataRemover(Profile* profile, base::Time delete_begin,
-                      base::Time delete_end);
+  // Creates a BrowsingDataRemover object that removes data regardless of the
+  // time it was last modified.
+  static BrowsingDataRemover* CreateForUnboundedRange(Profile* profile);

[cbentzel, 2012/08/29 01:53:13]

Should these return scoped_ptr<BrowsingDataRemover> so ownership expectations
are clear?

[Mike West, 2012/09/03 08:02:57]

BrowsingDataRemover has very strange semantics, in that it deletes itself after
removal is done. I don't think scoped_ptr is correct in that case, as the
creator doesn't actually retain ownership of the pointer.

[markusheintz_, 2012/09/03 08:58:44]

Maybe you should mention in the comment, that the BrowsingDataRemover deletes
itself.

I'll also file a bug for changing this as it seems more complicated as it looks.
I guess that make a very nice starter bug.

 
-  // Creates a BrowsingDataRemover to remove browser data from the specified
-  // profile in the specified time range.
-  BrowsingDataRemover(Profile* profile, TimePeriod time_period,
-                      base::Time delete_end);
+  // Creates a BrowsingDataRemover object bound on both sides by a time.
+  static BrowsingDataRemover* CreateForRange(Profile* profile,
+                                             base::Time delete_begin,
+                                             base::Time delete_end);
+
+  // Creates a BrowsingDataRemover bound to a specific period of time (as
+  // defined via a TimePeriod).
+  static BrowsingDataRemover* CreateForPeriod(Profile* profile,
+                                              TimePeriod deletionPeriod);

[jam, 2012/08/28 16:13:04]

nit: google  style is deletion_period

[Mike West, 2012/09/03 08:02:57]

Will do.

+
+  // Quota managed data uses a different bitmask for types than
+  // BrowsingDataRemover uses. This method generates that mask.
+  static int GenerateQuotaClientMask(int remove_mask);
+
+  // Is the BrowsingDataRemover currently in the process of removing data?
+  static bool is_removing() { return removing_; }

[jam, 2012/08/28 16:13:04]

nit: this should be beside the set_removing setter. also, it should be called
removing() per the style guide

[Mike West, 2012/09/03 08:02:57]

Will do.

 
   // Removes the specified items related to browsing for all origins that match
   // the provided |origin_set_mask| (see BrowsingDataHelper::OriginSetMask).
   void Remove(int remove_mask, int origin_set_mask);
 
   void AddObserver(Observer* observer);
   void RemoveObserver(Observer* observer);
 
   // Called when history deletion is done.
   void OnHistoryDeletionDone();
 
-  // Quota managed data uses a different bitmask for types than
-  // BrowsingDataRemover uses. This method generates that mask.
-  static int GenerateQuotaClientMask(int remove_mask);
-
   // Used for testing.
   void OverrideQuotaManagerForTesting(quota::QuotaManager* quota_manager);
 
-  static bool is_removing() { return removing_; }
-
  private:
   // The clear API needs to be able to toggle removing_ in order to test that
   // only one BrowsingDataRemover instance can be called at a time.
   FRIEND_TEST_ALL_PREFIXES(ExtensionBrowsingDataTest, OneAtATime);
 
   // The BrowsingDataRemover tests need to be able to access the implementation
   // of Remove(), as it exposes details that aren't yet available in the public
   // API. As soon as those details are exposed via new methods, this should be
   // removed.
   //
   // TODO(mkwst): See http://crbug.com/113621
   friend class BrowsingDataRemoverTest;
 
   enum CacheState {
     STATE_NONE,
     STATE_CREATE_MAIN,
     STATE_CREATE_MEDIA,
     STATE_DELETE_MAIN,
     STATE_DELETE_MEDIA,
     STATE_DONE
   };
 
+  // Calculate the begin time for the deletion range specified by |time_period|.
+  static base::Time CalculateBeginDeleteTime(TimePeriod time_period);
+
+  // Creates a BrowsingDataRemover to remove browser data from the specified
+  // profile in the specified time range. Use Remove to initiate the removal.
+  BrowsingDataRemover(Profile* profile, base::Time delete_begin,
+                      base::Time delete_end);
+
   // BrowsingDataRemover deletes itself (using DeleteHelper) and is not supposed
   // to be deleted by other objects so make destructor private and DeleteHelper
   // a friend.
   friend class base::DeleteHelper<BrowsingDataRemover>;
   virtual ~BrowsingDataRemover();
 
   // content::NotificationObserver method. Callback when TemplateURLService has
   // finished loading. Deletes the entries from the model, and if we're not
   // waiting on anything else notifies observers and deletes this
   // BrowsingDataRemover.
@@ skipping 99 matching lines @@
   // NotifyAndDeleteIfDone.
   void OnClearedServerBoundCerts();
 
   // Callback on the DB thread so that we can wait for the form data to be
   // cleared.
   void FormDataDBThreadHop();
 
   // Callback from the above method.
   void OnClearedFormData();
 
-  // Calculate the begin time for the deletion range specified by |time_period|.
-  base::Time CalculateBeginDeleteTime(TimePeriod time_period);
-
   // Returns true if we're all done.
   bool AllDone();
 
   // Setter for removing_; DCHECKs that we can only start removing if we're not
   // already removing, and vice-versa.
   static void set_removing(bool removing);
 
   content::NotificationRegistrar registrar_;
 
   // Profile we're to remove from.
@@ skipping 64 matching lines @@
 
   ObserverList<Observer> observer_list_;
 
   // Used if we need to clear history.
   CancelableRequestConsumer request_consumer_;
 
   DISALLOW_COPY_AND_ASSIGN(BrowsingDataRemover);
 };
 
 #endif  // CHROME_BROWSER_BROWSING_DATA_BROWSING_DATA_REMOVER_H_