Package org.apache.rat.annotation

Class ApacheV2LicenseAppender

java.lang.Object

org.apache.rat.annotation.AbstractLicenseAppender

org.apache.rat.annotation.ApacheV2LicenseAppender

public class ApacheV2LicenseAppender
extends AbstractLicenseAppender

Add an Apache License V2 license header to a document. This appender does not check for the existence of an existing license header, it is assumed that either a second license header is intentional or that there is no license header present already.

Constructor Summary

Constructors

Constructor	Description
ApacheV2LicenseAppender()	Create a license appender with the standard ASF license header.
ApacheV2LicenseAppender(String copyright)	Create a license appender with the given copyright line.

Method Summary

Modifier and Type	Method	Description
String	getLicenseHeader(File document)	Gets the header text to insert into the file.

Methods inherited from class org.apache.rat.annotation.AbstractLicenseAppender

append, getFirstLine, getLastLine, getLine, getType, setOverwrite

Methods inherited from class java.lang.Object

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

Constructor Details

ApacheV2LicenseAppender

public ApacheV2LicenseAppender()

Create a license appender with the standard ASF license header.

ApacheV2LicenseAppender

public ApacheV2LicenseAppender(String copyright)

Create a license appender with the given copyright line. This should be of the form "Copyright 2008 Foo"

Parameters:

copyright - copyright line to add to the headers.

Method Details

getLicenseHeader

public String getLicenseHeader(File document)

Description copied from class: AbstractLicenseAppender

Gets the header text to insert into the file.

Specified by:

getLicenseHeader in class AbstractLicenseAppender

Parameters:

document - document to extract from.

Returns:

Get the license header of a document.