1 /******************************************************************************
2  *
3  *  Copyright 2022 Google, Inc.
4  *
5  *  Licensed under the Apache License, Version 2.0 (the "License");
6  *  you may not use this file except in compliance with the License.
7  *  You may obtain a copy of the License at:
8  *
9  *  http://www.apache.org/licenses/LICENSE-2.0
10  *
11  *  Unless required by applicable law or agreed to in writing, software
12  *  distributed under the License is distributed on an "AS IS" BASIS,
13  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  *  See the License for the specific language governing permissions and
15  *  limitations under the License.
16  *
17  ******************************************************************************/
18 
19 #pragma once
20 
21 #include <string>
22 
23 namespace bluetooth {
24 namespace common {
25 
26 class ILoggable {
27  public:
28   // the interface for
29   // converting an object to a string for feeding to loggers
30   // e.g.. logcat
31   virtual std::string ToStringForLogging() const = 0;
32   virtual ~ILoggable() = default;
33 };
34 
35 class IRedactableLoggable : public ILoggable {
36  public:
37   // the interface for
38   // converting an object to a string with sensitive info redacted
39   // to avoid violating privacy
40   virtual std::string ToRedactedStringForLogging() const = 0;
41   virtual ~IRedactableLoggable() = default;
42 };
43 
44 }  // namespace common
45 }  // namespace bluetooth
46