Package com.mycila.maven.plugin.license.header

Class HeaderParser

java.lang.Object

com.mycila.maven.plugin.license.header.HeaderParser

public final class HeaderParser
extends Object

The HeaderParser class is used to get header information about the current header defined in the given file. The achieve this it will use the HeaderDefinition associated to the type of the given file.

Important: is considered a license header a header which contains the word copyright (case insensitive) within a section of the file which match the given HeaderDefinition associated to this HeaderParser.

See Also:

HeaderDefinition

Constructor Summary

Constructors

Constructor	Description
HeaderParser(FileContent fileContent, HeaderDefinition headerDefinition, String[] keywords)	Creates a HeaderParser object linked to the given file content and the associated header definition based on the file type.

Method Summary

Modifier and Type	Method	Description
int	getBeginPosition()	Returns the index position in the content where the header effectively starts.
int	getEndPosition()	Returns the index position in the content where the header effectively ends.
FileContent	getFileContent()	Returns the file content.
HeaderDefinition	getHeaderDefinition()	Returns the header definition associated to this header parser (itself bounded to a file).
boolean	gotAnyHeader()	Tells if the given file already contains a license header.

Methods inherited from class java.lang.Object

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

Constructor Detail

HeaderParser

public HeaderParser(FileContent fileContent,
                    HeaderDefinition headerDefinition,
                    String[] keywords)

Creates a HeaderParser object linked to the given file content and the associated header definition based on the file type.

Parameters:

fileContent - The file content.

headerDefinition - The associated header definition to use.

Throws:

IllegalArgumentException - If the file content is null or if the header definition is null.

Method Detail

getBeginPosition

public int getBeginPosition()

Returns the index position in the content where the header effectively starts.

Returns:

The index in the content.

getEndPosition

public int getEndPosition()

Returns the index position in the content where the header effectively ends.

Returns:

The index in the content.

gotAnyHeader

public boolean gotAnyHeader()

Tells if the given file already contains a license header.

Returns:

true if a license header has been detect or false.

getFileContent

public FileContent getFileContent()

Returns the file content.

Returns:

The content.

getHeaderDefinition

public HeaderDefinition getHeaderDefinition()

Returns the header definition associated to this header parser (itself bounded to a file).

Returns:

The associated header definition.