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

Interface PostProcessorPlugin

All Superinterfaces:

FilePlugin<PostProcessorContext,List<FileContext>>, Plugin

All Known Implementing Classes:

AbstractPostProcessor

public interface PostProcessorPlugin
extends FilePlugin<PostProcessorContext,List<FileContext>>

Plugin that allows to post-process a generated file.

Method Summary

Modifier and Type	Method	Description
List<FileContext>	apply(FileContext file, PostProcessorContext context)	Applies the post processing.
default ImplicitApplyOptions	implicitApply(FileContext file, PostProcessorContext 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,
                                           PostProcessorContext context)

Whether to apply this plugin implicitly.

Specified by:

implicitApply in interface FilePlugin<PostProcessorContext,List<FileContext>>

Parameters:

file - Context file

context - Context objects

Returns:

Implicit apply option

apply

List<FileContext> apply(FileContext file,
                        PostProcessorContext context)

Applies the post processing.

Specified by:

apply in interface FilePlugin<PostProcessorContext,List<FileContext>>

Parameters:

file - Context file

context - Context objects

Returns:

Returns a list of files that where generated additionally or instead of the input file. The input file itself should never be returned, otherwise files may get processed twice.