1/*
2 * Copyright (C) 2011 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 *      http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17#ifndef ART_RUNTIME_BASE_DUMPABLE_H_
18#define ART_RUNTIME_BASE_DUMPABLE_H_
19
20#include <ostream>
21
22#include "base/macros.h"
23
24namespace art {
25
26// A convenience to allow any class with a "Dump(std::ostream& os)" member function
27// but without an operator<< to be used as if it had an operator<<. Use like this:
28//
29//   os << Dumpable<MyType>(my_type_instance);
30//
31template<typename T>
32class Dumpable FINAL {
33 public:
34  explicit Dumpable(const T& value) : value_(value) {
35  }
36
37  void Dump(std::ostream& os) const {
38    value_.Dump(os);
39  }
40
41 private:
42  const T& value_;
43
44  DISALLOW_COPY_AND_ASSIGN(Dumpable);
45};
46
47template<typename T>
48std::ostream& operator<<(std::ostream& os, const Dumpable<T>& rhs) {
49  rhs.Dump(os);
50  return os;
51}
52
53}  // namespace art
54
55#endif  // ART_RUNTIME_BASE_DUMPABLE_H_
56