Package org.codehaus.mojo.license.header

Class FileHeader

java.lang.Object
org.codehaus.mojo.license.header.FileHeader
public class FileHeader extends Object
Contract of a file header. A header has three sections like in this example : 
 Description
 %--
 Copyright (C) firstYear[ - lastYear] holder
 %--
 License
Since:
1.0
Author:
tchemit dev@tchemit.fr

  • Field Details

    • description

      protected String description
      Description of the project or module to add in header.

    • license

      protected String license
      License used in the header.

  • Constructor Details

    • FileHeader

      public FileHeader()

  • Method Details

    • getDescription

      public String getDescription()
      Returns:
      the project name, or nay other common informations for all files of a project (or module)

    • getCopyright

      public Copyright getCopyright()
      Returns:
      the copyright model.

    • getLicense

      public String getLicense()
      Returns:
      the license content (this is not the fully license content, but just a per file license resume)

    • setCopyright

      public void setCopyright(Copyright copyright)

    • setDescription

      public void setDescription(String description)

    • setLicense

      public void setLicense(String license)