Package io.wcm.devops.conga.plugins.sling.fileheader

Class OsgiConfigFileHeader

java.lang.Object

io.wcm.devops.conga.generator.plugins.fileheader.AbstractFileHeader

io.wcm.devops.conga.plugins.sling.fileheader.OsgiConfigFileHeader

All Implemented Interfaces:

io.wcm.devops.conga.generator.spi.FileHeaderPlugin, io.wcm.devops.conga.generator.spi.FilePlugin<io.wcm.devops.conga.generator.spi.context.FileHeaderContext,Void>, io.wcm.devops.conga.generator.spi.Plugin

public final class OsgiConfigFileHeader
extends io.wcm.devops.conga.generator.plugins.fileheader.AbstractFileHeader

Adds file headers to OSGi .config files.

Please note: This plugin converts the file header to a single comment line, because Felix Configuation Admin Service versions < 1.8.8 do not support multi-line comments.

Field Summary

Fields

Modifier and Type	Field	Description
static String	NAME	Plugin name

Constructor Summary

Constructors

Constructor	Description
OsgiConfigFileHeader()

Method Summary

Modifier and Type	Method	Description
boolean	accepts(io.wcm.devops.conga.generator.spi.context.FileContext file, io.wcm.devops.conga.generator.spi.context.FileHeaderContext context)
io.wcm.devops.conga.generator.spi.context.FileHeaderContext	extract(io.wcm.devops.conga.generator.spi.context.FileContext file)
protected String	getCommentBlockEnd()
protected String	getCommentBlockStart()
protected String	getCommentLinePrefix()
protected String	getLineBreak()
String	getName()
protected String	sanitizeComment(String line)

Methods inherited from class io.wcm.devops.conga.generator.plugins.fileheader.AbstractFileHeader

apply, extractFileHeaderBetweenBlockStartEnd, extractFileHeaderWithLinePrefixes, getBlockSuffix, getInsertPosition

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.wcm.devops.conga.generator.spi.FileHeaderPlugin

implicitApply

Field Detail

NAME

public static final String NAME

Plugin name

See Also:

Constant Field Values

Constructor Detail

OsgiConfigFileHeader

public OsgiConfigFileHeader()

Method Detail

getName

public String getName()

accepts

public boolean accepts(io.wcm.devops.conga.generator.spi.context.FileContext file,
                       io.wcm.devops.conga.generator.spi.context.FileHeaderContext context)

sanitizeComment

protected String sanitizeComment(String line)

Overrides:

sanitizeComment in class io.wcm.devops.conga.generator.plugins.fileheader.AbstractFileHeader

getCommentLinePrefix

protected String getCommentLinePrefix()

Overrides:

getCommentLinePrefix in class io.wcm.devops.conga.generator.plugins.fileheader.AbstractFileHeader

getCommentBlockStart

protected String getCommentBlockStart()

Overrides:

getCommentBlockStart in class io.wcm.devops.conga.generator.plugins.fileheader.AbstractFileHeader

getCommentBlockEnd

protected String getCommentBlockEnd()

Overrides:

getCommentBlockEnd in class io.wcm.devops.conga.generator.plugins.fileheader.AbstractFileHeader

getLineBreak

protected String getLineBreak()

Overrides:

getLineBreak in class io.wcm.devops.conga.generator.plugins.fileheader.AbstractFileHeader

extract

public io.wcm.devops.conga.generator.spi.context.FileHeaderContext extract(io.wcm.devops.conga.generator.spi.context.FileContext file)