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

Class AnyFileHeader

java.lang.Object

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

io.wcm.devops.conga.plugins.aem.fileheader.AnyFileHeader

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 AnyFileHeader
extends io.wcm.devops.conga.generator.plugins.fileheader.AbstractFileHeader

Adds file headers to ANY files.

Field Summary

Fields

Modifier and Type	Field	Description
static String	NAME	Plugin name

Constructor Summary

Constructors

Constructor	Description
AnyFileHeader()

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	getBlockSuffix()
protected String	getCommentLinePrefix()
String	getName()

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

apply, extractFileHeaderBetweenBlockStartEnd, extractFileHeaderWithLinePrefixes, getCommentBlockEnd, getCommentBlockStart, getInsertPosition, getLineBreak, sanitizeComment

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

AnyFileHeader

public AnyFileHeader()

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)

getCommentLinePrefix

protected String getCommentLinePrefix()

Overrides:

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

getBlockSuffix

protected String getBlockSuffix()

Overrides:

getBlockSuffix 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)