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

Class NoneFileHeader

java.lang.Object

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

All Implemented Interfaces:

FileHeaderPlugin, FilePlugin<FileHeaderContext,Void>, Plugin

public final class NoneFileHeader
extends Object
implements FileHeaderPlugin

Adds no file header.

Field Summary

Fields

Modifier and Type	Field	Description
static String	NAME	Plugin name

Constructor Summary

Constructors

Constructor	Description
NoneFileHeader()

Method Summary

Modifier and Type	Method	Description
boolean	accepts(FileContext file, FileHeaderContext context)	Checks if the plugin can be applied to the given file.
Void	apply(FileContext file, FileHeaderContext context)	Applies the comment file header.
String	getName()
ImplicitApplyOptions	implicitApply(FileContext file, FileHeaderContext context)	Whether to apply this plugin implicitly.

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

extract

Field Detail

NAME

public static final String NAME

Plugin name

See Also:

Constant Field Values

Constructor Detail

NoneFileHeader

public NoneFileHeader()

Method Detail

getName

public String getName()

Specified by:

getName in interface Plugin

Returns:

Plugin name to be referenced in definition file

accepts

public boolean accepts(FileContext file,
                       FileHeaderContext context)

Description copied from interface: FilePlugin

Checks if the plugin can be applied to the given file.

Specified by:

accepts in interface FilePlugin<FileHeaderContext,Void>

Parameters:

file - Context file

context - Context objects

Returns:

true when the plugin can be applied to the given file.

implicitApply

public ImplicitApplyOptions implicitApply(FileContext file,
                                          FileHeaderContext context)

Description copied from interface: FileHeaderPlugin

Whether to apply this plugin implicitly.

Specified by:

implicitApply in interface FileHeaderPlugin

Specified by:

implicitApply in interface FilePlugin<FileHeaderContext,Void>

Parameters:

file - Context file

context - Context objects

Returns:

Implicit apply option

apply

public Void apply(FileContext file,
                  FileHeaderContext context)

Description copied from interface: FileHeaderPlugin

Applies the comment file header.

Specified by:

apply in interface FileHeaderPlugin

Specified by:

apply in interface FilePlugin<FileHeaderContext,Void>

Parameters:

file - Context file

context - Context objects

Returns:

nothing