org.nuiton.license.plugin.header.generator
Interface HeaderGenerator

All Known Implementing Classes:

JavaLicenseHeaderGeneratorImpl, LicenseHeaderGenerator, PropertiesLicenseHeaderGeneratorImpl, XmlLicenseHeaderGeneratorImpl

public interface HeaderGenerator

A simple Contract to generate a new header for a given type of file.

Since:

1.0.0

Author:

chemit

Field Summary

static String

ROLE_NAME Plexus role name

Method Summary

String	getCloseProcessTag()
String	getCloseTag()
String	getDescription()
String	getHeader(String content)
String	getLinePrefix()
String	getName()
String	getOpenProcessTag()
String	getOpenTag()
String	prefixContent(String content)
void	setCloseProcessTag(String closeProcessTag)
void	setCloseTag(String closeTag)
void	setLinePrefix(String linePrefix)
void	setOpenProcessTag(String openProcessTag)
void	setOpenTag(String openTag)

Field Detail

ROLE_NAME

static final String ROLE_NAME

Plexus role name

Method Detail

getName

String getName()

Returns:

the name of the generator

getDescription

String getDescription()

Returns:

the description of the generator

getHeader

String getHeader(String content)

Parameters:

content - the content to box.

Returns:

the full header to add on the first line of file.

getLinePrefix

String getLinePrefix()

Returns:

the prefix to add on each lines of the header

prefixContent

String prefixContent(String content)
                     throws IOException

Parameters:

content -

Returns:

the prefix content

Throws:

IOException - if any io exceptions

getOpenTag

String getOpenTag()

getCloseTag

String getCloseTag()

getOpenProcessTag

String getOpenProcessTag()

getCloseProcessTag

String getCloseProcessTag()

setLinePrefix

void setLinePrefix(String linePrefix)

setOpenTag

void setOpenTag(String openTag)

setCloseTag

void setCloseTag(String closeTag)

setOpenProcessTag

void setOpenProcessTag(String openProcessTag)

setCloseProcessTag

void setCloseProcessTag(String closeProcessTag)