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:

JavaLicenseHeaderGeneratorImpl, PropertiesLicenseHeaderGeneratorImpl, XmlLicenseHeaderGeneratorImpl

public abstract class LicenseHeaderGenerator
extends java.lang.Object
implements HeaderGenerator

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

Since:

1.0.1

Author:

chemit

Field Summary

protected java.lang.String	closeProcessTag
protected java.lang.String	closeTag
protected java.lang.String	linePrefix
protected java.lang.String	openProcessTag
protected java.lang.String	openTag

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

ROLE_NAME

Constructor Summary

LicenseHeaderGenerator(java.lang.String linePrefix, java.lang.String openTag, java.lang.String closeTag, java.lang.String openProcessTag, java.lang.String closeProcessTag)

Method Summary

java.lang.String	getCloseProcessTag()
java.lang.String	getCloseTag()
java.lang.String	getHeader(java.lang.String licenseHeaderContent)
java.lang.String	getLinePrefix()
java.lang.String	getOpenProcessTag()
java.lang.String	getOpenTag()
java.lang.String	prefixContent(java.lang.String content)
void	setCloseProcessTag(java.lang.String closeProcessTag)
void	setCloseTag(java.lang.String closeTag)
void	setLinePrefix(java.lang.String linePrefix)
void	setOpenProcessTag(java.lang.String openProcessTag)
void	setOpenTag(java.lang.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 java.lang.String linePrefix

openTag

protected java.lang.String openTag

closeTag

protected java.lang.String closeTag

openProcessTag

protected java.lang.String openProcessTag

closeProcessTag

protected java.lang.String closeProcessTag

Constructor Detail

LicenseHeaderGenerator

public LicenseHeaderGenerator(java.lang.String linePrefix,
                              java.lang.String openTag,
                              java.lang.String closeTag,
                              java.lang.String openProcessTag,
                              java.lang.String closeProcessTag)

Method Detail

getHeader

public java.lang.String getHeader(java.lang.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 java.lang.String prefixContent(java.lang.String content)
                               throws java.io.IOException

Specified by:

prefixContent in interface HeaderGenerator

Returns:

the prefix content

Throws:

java.io.IOException

getLinePrefix

public java.lang.String getLinePrefix()

Specified by:

getLinePrefix in interface HeaderGenerator

Returns:

the prefix to add on each lines of the header

getCloseProcessTag

public java.lang.String getCloseProcessTag()

Specified by:

getCloseProcessTag in interface HeaderGenerator

getCloseTag

public java.lang.String getCloseTag()

Specified by:

getCloseTag in interface HeaderGenerator

getOpenProcessTag

public java.lang.String getOpenProcessTag()

Specified by:

getOpenProcessTag in interface HeaderGenerator

getOpenTag

public java.lang.String getOpenTag()

Specified by:

getOpenTag in interface HeaderGenerator

setCloseProcessTag

public void setCloseProcessTag(java.lang.String closeProcessTag)

Specified by:

setCloseProcessTag in interface HeaderGenerator

setCloseTag

public void setCloseTag(java.lang.String closeTag)

Specified by:

setCloseTag in interface HeaderGenerator

setLinePrefix

public void setLinePrefix(java.lang.String linePrefix)

Specified by:

setLinePrefix in interface HeaderGenerator

setOpenProcessTag

public void setOpenProcessTag(java.lang.String openProcessTag)

Specified by:

setOpenProcessTag in interface HeaderGenerator

setOpenTag

public void setOpenTag(java.lang.String openTag)

Specified by:

setOpenTag in interface HeaderGenerator