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 Summary

Fields

Modifier and Type	Field and Description
protected Copyright	copyright Copyright model.
protected String	description Description of the project or module to add in header.
protected String	license License used in the header.

Constructor Summary

Constructors

Constructor and Description
FileHeader()

Method Summary

Modifier and Type	Method and Description
Copyright	getCopyright()
String	getDescription()
String	getLicense()
void	setCopyright(Copyright copyright)
void	setDescription(String description)
void	setLicense(String license)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

description

protected String description

Description of the project or module to add in header.

copyright

protected Copyright copyright

Copyright model.

license

protected String license

License used in the header.

Constructor Detail

FileHeader

public FileHeader()

Method Detail

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)