org.nuiton.license.plugin.header.generator
Class LicenseHeaderGenerator

java.lang.Object
  org.nuiton.license.plugin.header.generator.LicenseHeaderGenerator

All Implemented Interfaces:

HeaderGenerator

Direct Known Subclasses:

AptLicenseHeaderGeneratorImpl, JavaLicenseHeaderGeneratorImpl, PropertiesLicenseHeaderGeneratorImpl, XmlLicenseHeaderGeneratorImpl

public abstract class LicenseHeaderGenerator
extends Object
implements HeaderGenerator

Une implentation de base pour les generateur d'en-tete de license.

Since:

1.0.1

Author:

chemit

Field Summary

protected String	closeProcessTag
protected String	closeTag
protected String	linePrefix
protected String	openProcessTag
protected String	openTag

Fields inherited from interface org.nuiton.license.plugin.header.generator.HeaderGenerator

ROLE_NAME

Constructor Summary

LicenseHeaderGenerator(String linePrefix, String openTag, String closeTag, String openProcessTag, String closeProcessTag)

Method Summary

String	getCloseProcessTag()
String	getCloseTag()
String	getHeader(String licenseHeaderContent)
String	getLinePrefix()
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)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.nuiton.license.plugin.header.generator.HeaderGenerator

getDescription, getName

Field Detail

linePrefix

protected String linePrefix

openTag

protected String openTag

closeTag

protected String closeTag

openProcessTag

protected String openProcessTag

closeProcessTag

protected String closeProcessTag

Constructor Detail

LicenseHeaderGenerator

public LicenseHeaderGenerator(String linePrefix,
                              String openTag,
                              String closeTag,
                              String openProcessTag,
                              String closeProcessTag)

Method Detail

getHeader

public String getHeader(String licenseHeaderContent)

Specified by:

getHeader in interface HeaderGenerator

Parameters:

licenseHeaderContent - the content to box.

Returns:

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

prefixContent

public String prefixContent(String content)
                     throws IOException

Specified by:

prefixContent in interface HeaderGenerator

Returns:

the prefix content

Throws:

IOException - if any io exceptions

getLinePrefix

public String getLinePrefix()

Specified by:

getLinePrefix in interface HeaderGenerator

Returns:

the prefix to add on each lines of the header

getCloseProcessTag

public String getCloseProcessTag()

Specified by:

getCloseProcessTag in interface HeaderGenerator

getCloseTag

public String getCloseTag()

Specified by:

getCloseTag in interface HeaderGenerator

getOpenProcessTag

public String getOpenProcessTag()

Specified by:

getOpenProcessTag in interface HeaderGenerator

getOpenTag

public String getOpenTag()

Specified by:

getOpenTag in interface HeaderGenerator

setCloseProcessTag

public void setCloseProcessTag(String closeProcessTag)

Specified by:

setCloseProcessTag in interface HeaderGenerator

setCloseTag

public void setCloseTag(String closeTag)

Specified by:

setCloseTag in interface HeaderGenerator

setLinePrefix

public void setLinePrefix(String linePrefix)

Specified by:

setLinePrefix in interface HeaderGenerator

setOpenProcessTag

public void setOpenProcessTag(String openProcessTag)

Specified by:

setOpenProcessTag in interface HeaderGenerator

setOpenTag

public void setOpenTag(String openTag)

Specified by:

setOpenTag in interface HeaderGenerator