BaseTools: Clean up source files

[mirror_edk2.git] / BaseTools / Source / Python / UPT / Object / Parser / InfHeaderObject.py

## @file\r
# This file is used to define class objects of INF file header.\r
# It will consumed by InfParser.\r
#\r
# Copyright (c) 2011 - 2018, Intel Corporation. All rights reserved.<BR>\r
#\r
# This program and the accompanying materials are licensed and made available\r
# under the terms and conditions of the BSD License which accompanies this\r
# distribution. The full text of the license may be found at\r
# http://opensource.org/licenses/bsd-license.php\r
#\r
# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
'''\r
InfHeaderObject\r
'''\r
\r
## INF file header object\r
#\r
# A sample file header\r
#\r
# ## @file xxx.inf FileName\r
# # Abstract\r
# #\r
# # Description\r
# #\r
# # Copyright\r
# #\r
# # License\r
# #\r
#\r
class InfHeaderObject():\r
    def __init__(self):\r
        self.FileName    = ''\r
        self.Abstract    = ''\r
        self.Description = ''\r
        self.Copyright   = ''\r
        self.License     = ''\r
\r
    ## SetFileName\r
    #\r
    # @param FileName: File Name\r
    #\r
    def SetFileName(self, FileName):\r
        if not (FileName == '' or FileName is None):\r
            self.FileName = FileName\r
            return True\r
        else:\r
            return False\r
\r
    ## GetFileName\r
    #\r
    def GetFileName(self):\r
        return self.FileName\r
\r
    ## SetAbstract\r
    #\r
    # @param Abstract: Abstract\r
    #\r
    def SetAbstract(self, Abstract):\r
        if not (Abstract == '' or Abstract is None):\r
            self.Abstract = Abstract\r
            return True\r
        else:\r
            return False\r
\r
    ## GetAbstract\r
    #\r
    def GetAbstract(self):\r
        return self.Abstract\r
\r
    ## SetDescription\r
    #\r
    # @param Description: Description content\r
    #\r
    def SetDescription(self, Description):\r
        if not (Description == '' or Description is None):\r
            self.Description = Description\r
            return True\r
        else:\r
            return False\r
\r
    ## GetAbstract\r
    #\r
    def GetDescription(self):\r
        return self.Description\r
\r
    ## SetCopyright\r
    #\r
    # @param Copyright: Copyright content\r
    #\r
    def SetCopyright(self, Copyright):\r
        if not (Copyright == '' or Copyright is None):\r
            self.Copyright = Copyright\r
            return True\r
        else:\r
            return False\r
\r
    ## GetCopyright\r
    #\r
    def GetCopyright(self):\r
        return self.Copyright\r
\r
    ## SetCopyright\r
    #\r
    # @param License: License content\r
    #\r
    def SetLicense(self, License):\r
        if not (License == '' or License is None):\r
            self.License = License\r
            return True\r
        else:\r
            return False\r
\r
    ## GetLicense\r
    #\r
    def GetLicense(self):\r
        return self.License\r