Start sorting methods in class declarations.

base/values.h

-// Copyright (c) 2010 The Chromium Authors. All rights reserved.
+// Copyright (c) 2011 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.
 
 // This file specifies a recursive data storage class called Value intended for
 // storing setting and other persistable data.  It includes the ability to
 // specify (recursive) lists and dictionaries, so it's fairly expressive.
 // However, the API is optimized for the common case, namely storing a
 // hierarchical tree of simple values.  Given a DictionaryValue root, you can
 // easily do things like:
 //
@@ skipping 27 matching lines @@
 class ListValue;
 
 typedef std::vector<Value*> ValueVector;
 typedef std::map<std::string, Value*> ValueMap;
 
 // The Value class is the base class for Values.  A Value can be
 // instantiated via the Create*Value() factory methods, or by directly
 // creating instances of the subclasses.
 class Value {
  public:
+  enum ValueType {
+    TYPE_NULL = 0,
+    TYPE_BOOLEAN,
+    TYPE_INTEGER,
+    TYPE_REAL,
+    TYPE_STRING,
+    TYPE_BINARY,
+    TYPE_DICTIONARY,
+    TYPE_LIST
+  };
+
   virtual ~Value();
 
   // Convenience methods for creating Value objects for various
   // kinds of values without thinking about which class implements them.
   // These can always be expected to return a valid Value*.
   static Value* CreateNullValue();
   static Value* CreateBooleanValue(bool in_value);
   static Value* CreateIntegerValue(int in_value);
   static Value* CreateRealValue(double in_value);
   static Value* CreateStringValue(const std::string& in_value);
   static Value* CreateStringValue(const string16& in_value);
 
   // This one can return NULL if the input isn't valid.  If the return value
   // is non-null, the new object has taken ownership of the buffer pointer.
   static BinaryValue* CreateBinaryValue(char* buffer, size_t size);
 
-  typedef enum {
-    TYPE_NULL = 0,
-    TYPE_BOOLEAN,
-    TYPE_INTEGER,
-    TYPE_REAL,
-    TYPE_STRING,
-    TYPE_BINARY,
-    TYPE_DICTIONARY,
-    TYPE_LIST
-  } ValueType;
-
   // Returns the type of the value stored by the current Value object.
   // Each type will be implemented by only one subclass of Value, so it's
   // safe to use the ValueType to determine whether you can cast from
   // Value* to (Implementing Class)*.  Also, a Value object never changes
   // its type after construction.
   ValueType GetType() const { return type_; }
 
   // Returns true if the current object represents a given type.
   bool IsType(ValueType type) const { return type == type_; }
 
@@ skipping 74 matching lines @@
   virtual bool Equals(const Value* other) const;
 
  private:
   std::string value_;
 
   DISALLOW_COPY_AND_ASSIGN(StringValue);
 };
 
 class BinaryValue: public Value {
  public:
+  virtual ~BinaryValue();
+
   // Creates a Value to represent a binary buffer.  The new object takes
   // ownership of the pointer passed in, if successful.
   // Returns NULL if buffer is NULL.
   static BinaryValue* Create(char* buffer, size_t size);
 
   // For situations where you want to keep ownership of your buffer, this
   // factory method creates a new BinaryValue by copying the contents of the
   // buffer that's passed in.
   // Returns NULL if buffer is NULL.
   static BinaryValue* CreateWithCopiedBuffer(const char* buffer, size_t size);
 
-  virtual ~BinaryValue();
-
-  // Subclassed methods
-  virtual Value* DeepCopy() const;
-  virtual bool Equals(const Value* other) const;
-
   size_t GetSize() const { return size_; }
   char* GetBuffer() { return buffer_; }
   const char* GetBuffer() const { return buffer_; }
 
+  // Overridden from Value:
+  virtual Value* DeepCopy() const;
+  virtual bool Equals(const Value* other) const;
+
  private:
   // Constructor is private so that only objects with valid buffer pointers
   // and size values can be created.
   BinaryValue(char* buffer, size_t size);
 
   char* buffer_;
   size_t size_;
 
   DISALLOW_COPY_AND_ASSIGN(BinaryValue);
 };
 
 // DictionaryValue provides a key-value dictionary with (optional) "path"
 // parsing for recursive access; see the comment at the top of the file. Keys
 // are |std::string|s and should be UTF-8 encoded.
 class DictionaryValue : public Value {
  public:
   DictionaryValue();
   virtual ~DictionaryValue();
 
-  // Subclassed methods
-  virtual Value* DeepCopy() const;
-  virtual bool Equals(const Value* other) const;
-
   // Returns true if the current dictionary has a value for the given key.
   bool HasKey(const std::string& key) const;
 
   // Returns the number of Values in this dictionary.
   size_t size() const { return dictionary_.size(); }
 
   // Returns whether the dictionary is empty.
   bool empty() const { return dictionary_.empty(); }
 
   // Clears any current contents of this dictionary.
@@ skipping 102 matching lines @@
     bool operator!=(const key_iterator& other) { return itr_ != other.itr_; }
     bool operator==(const key_iterator& other) { return itr_ == other.itr_; }
 
    private:
     ValueMap::const_iterator itr_;
   };
 
   key_iterator begin_keys() const { return key_iterator(dictionary_.begin()); }
   key_iterator end_keys() const { return key_iterator(dictionary_.end()); }
 
+  // Overridden from Value:
+  virtual Value* DeepCopy() const;
+  virtual bool Equals(const Value* other) const;
+
  private:
   ValueMap dictionary_;
 
   DISALLOW_COPY_AND_ASSIGN(DictionaryValue);
 };
 
 // This type of Value represents a list of other Value values.
 class ListValue : public Value {
  public:
+  typedef ValueVector::iterator iterator;
+  typedef ValueVector::const_iterator const_iterator;
+
   ListValue();
   ~ListValue();
 
-  // Subclassed methods
-  virtual bool GetAsList(ListValue** out_value);
-  virtual Value* DeepCopy() const;
-  virtual bool Equals(const Value* other) const;
-
   // Clears the contents of this ListValue
   void Clear();
 
   // Returns the number of Values in this list.
   size_t GetSize() const { return list_.size(); }
 
   // Returns whether the list is empty.
   bool empty() const { return list_.empty(); }
 
   // Sets the list item at the given index to be the Value specified by
@@ skipping 41 matching lines @@
   // Insert a Value at index.
   // Returns true if successful, or false if the index was out of range.
   bool Insert(size_t index, Value* in_value);
 
   // Swaps contents with the |other| list.
   void Swap(ListValue* other) {
     list_.swap(other->list_);
   }
 
   // Iteration
-  typedef ValueVector::iterator iterator;
-  typedef ValueVector::const_iterator const_iterator;
-
   ListValue::iterator begin() { return list_.begin(); }
   ListValue::iterator end() { return list_.end(); }
 
   ListValue::const_iterator begin() const { return list_.begin(); }
   ListValue::const_iterator end() const { return list_.end(); }
 
+  // Overridden from Value:
+  virtual bool GetAsList(ListValue** out_value);
+  virtual Value* DeepCopy() const;
+  virtual bool Equals(const Value* other) const;
+
  private:
   ValueVector list_;
 
   DISALLOW_COPY_AND_ASSIGN(ListValue);
 };
 
 // This interface is implemented by classes that know how to serialize and
 // deserialize Value objects.
 class ValueSerializer {
  public:
   virtual ~ValueSerializer();
 
   virtual bool Serialize(const Value& root) = 0;
 
   // This method deserializes the subclass-specific format into a Value object.
   // If the return value is non-NULL, the caller takes ownership of returned
   // Value. If the return value is NULL, and if error_code is non-NULL,
   // error_code will be set with the underlying error.
   // If |error_message| is non-null, it will be filled in with a formatted
   // error message including the location of the error if appropriate.
   virtual Value* Deserialize(int* error_code, std::string* error_str) = 0;
 };
 
 #endif  // BASE_VALUES_H_