1 /*
2  * Copyright (C) 2020 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 #pragma once
18 
19 #include <string>
20 
21 namespace android::vintf {
22 
23 // WithFileName is a class that attaches a name to an object.
24 // The name is often the file name or path of the source file where the object
25 // is deserialized from. The name is used for informational and debugging
26 // purposes. It is not retained when the object is serialized.
27 // It is not meant to be used as an identifier of the object:
28 // - there may be duplicated names;
29 // - name may be empty.
30 struct WithFileName {
31     WithFileName() = default;
WithFileNameWithFileName32     WithFileName(const std::string& fileName) : mFileName(fileName) {}
fileNameWithFileName33     const std::string& fileName() const { return mFileName; }
setFileNameWithFileName34     void setFileName(std::string&& fileName) { mFileName = std::move(fileName); }
setFileNameWithFileName35     void setFileName(const std::string& fileName) { mFileName = fileName; }
36 
37    private:
38     std::string mFileName;
39 };
40 
41 }  // namespace android::vintf
42