]> git.proxmox.com Git - mirror_edk2.git/blame - BaseTools/Source/Python/UPT/Object/Parser/InfHeaderObject.py
BaseTools: Replace BSD License with BSD+Patent License
[mirror_edk2.git] / BaseTools / Source / Python / UPT / Object / Parser / InfHeaderObject.py
CommitLineData
4234283c 1## @file\r
f7496d71
LG
2# This file is used to define class objects of INF file header.\r
3# It will consumed by InfParser.\r
4234283c 4#\r
f7496d71 5# Copyright (c) 2011 - 2018, Intel Corporation. All rights reserved.<BR>\r
4234283c 6#\r
2e351cbe 7# SPDX-License-Identifier: BSD-2-Clause-Patent\r
4234283c
LG
8\r
9'''\r
10InfHeaderObject\r
11'''\r
12\r
13## INF file header object\r
f7496d71 14#\r
4234283c
LG
15# A sample file header\r
16#\r
17# ## @file xxx.inf FileName\r
18# # Abstract\r
f7496d71 19# #\r
4234283c
LG
20# # Description\r
21# #\r
22# # Copyright\r
f7496d71 23# #\r
4234283c
LG
24# # License\r
25# #\r
26#\r
27class InfHeaderObject():\r
28 def __init__(self):\r
29 self.FileName = ''\r
30 self.Abstract = ''\r
31 self.Description = ''\r
32 self.Copyright = ''\r
33 self.License = ''\r
34\r
35 ## SetFileName\r
36 #\r
37 # @param FileName: File Name\r
f7496d71 38 #\r
4234283c 39 def SetFileName(self, FileName):\r
4231a819 40 if not (FileName == '' or FileName is None):\r
4234283c
LG
41 self.FileName = FileName\r
42 return True\r
43 else:\r
44 return False\r
45\r
46 ## GetFileName\r
f7496d71 47 #\r
4234283c
LG
48 def GetFileName(self):\r
49 return self.FileName\r
50\r
51 ## SetAbstract\r
f7496d71 52 #\r
4234283c 53 # @param Abstract: Abstract\r
f7496d71 54 #\r
4234283c 55 def SetAbstract(self, Abstract):\r
4231a819 56 if not (Abstract == '' or Abstract is None):\r
4234283c
LG
57 self.Abstract = Abstract\r
58 return True\r
59 else:\r
60 return False\r
61\r
62 ## GetAbstract\r
f7496d71 63 #\r
4234283c 64 def GetAbstract(self):\r
f7496d71 65 return self.Abstract\r
4234283c
LG
66\r
67 ## SetDescription\r
f7496d71
LG
68 #\r
69 # @param Description: Description content\r
70 #\r
4234283c 71 def SetDescription(self, Description):\r
4231a819 72 if not (Description == '' or Description is None):\r
4234283c
LG
73 self.Description = Description\r
74 return True\r
75 else:\r
76 return False\r
77\r
78 ## GetAbstract\r
f7496d71 79 #\r
4234283c 80 def GetDescription(self):\r
f7496d71 81 return self.Description\r
4234283c
LG
82\r
83 ## SetCopyright\r
f7496d71
LG
84 #\r
85 # @param Copyright: Copyright content\r
86 #\r
4234283c 87 def SetCopyright(self, Copyright):\r
4231a819 88 if not (Copyright == '' or Copyright is None):\r
4234283c
LG
89 self.Copyright = Copyright\r
90 return True\r
91 else:\r
92 return False\r
93\r
94 ## GetCopyright\r
f7496d71 95 #\r
4234283c 96 def GetCopyright(self):\r
f7496d71 97 return self.Copyright\r
4234283c
LG
98\r
99 ## SetCopyright\r
f7496d71
LG
100 #\r
101 # @param License: License content\r
102 #\r
4234283c 103 def SetLicense(self, License):\r
4231a819 104 if not (License == '' or License is None):\r
4234283c
LG
105 self.License = License\r
106 return True\r
107 else:\r
108 return False\r
109\r
110 ## GetLicense\r
f7496d71 111 #\r
4234283c 112 def GetLicense(self):\r
f7496d71 113 return self.License\r