Package io.wcm.devops.conga.generator.spi

Interface FileHeaderPlugin

All Superinterfaces:

FilePlugin<FileHeaderContext,Void>, Plugin

All Known Implementing Classes:

AbstractFileHeader, ConfFileHeader, JsonFileHeader, NoneFileHeader, UnixShellScriptFileHeader, WindowsShellScriptFileHeader, XmlFileHeader

public interface FileHeaderPlugin
extends FilePlugin<FileHeaderContext,Void>

Plugin that generates a file header comment with info that the file was automatically generated and further info like a timestamp.

Method Summary

Modifier and Type	Method	Description
Void	apply(FileContext file, FileHeaderContext context)	Applies the comment file header.
default FileHeaderContext	extract(FileContext file)	Extract comment lines from file header.
default ImplicitApplyOptions	implicitApply(FileContext file, FileHeaderContext context)	Whether to apply this plugin implicitly.

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

accepts

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

getName

Method Detail

implicitApply

default ImplicitApplyOptions implicitApply(FileContext file,
                                           FileHeaderContext context)

Whether to apply this plugin implicitly.

Specified by:

implicitApply in interface FilePlugin<FileHeaderContext,Void>

Parameters:

file - Context file

context - Context objects

Returns:

Implicit apply option

apply

Void apply(FileContext file,
           FileHeaderContext context)

Applies the comment file header.

Specified by:

apply in interface FilePlugin<FileHeaderContext,Void>

Parameters:

file - Context file

context - Context objects

Returns:

nothing

extract

default FileHeaderContext extract(FileContext file)

Extract comment lines from file header.

Parameters:

file - Context file

Returns:

File header context with comment lines. Returns null if extraction not possible or no comments present.