org.luossfi.gradle.plugin.fnwdgp

Class FileNamingWatchDogExtension

java.lang.Object

org.luossfi.gradle.plugin.fnwdgp.FileNamingWatchDogExtension

public class FileNamingWatchDogExtension
extends java.lang.Object

The Class FileNamingWatchDogExtension is the POJO which defines the plugin's configuration.

Since:

1.0

Constructor Summary

Constructors

Constructor and Description
FileNamingWatchDogExtension(org.gradle.api.Project project) Instantiates a new file naming watch dog extension.

Method Summary

Modifier and Type	Method and Description
java.io.File	getDefinitionFile() Gets the naming convention definition file.
java.util.Map<java.lang.String,java.lang.String>	getPlaceholderValues() Gets the placeholder values to be used for the naming convention definition file.
java.util.Set<java.io.File>	getSourceDirs() Gets the source directories to scan with the watch dog.
boolean	isFailBuild() Checks if the build should fail if the watch dog finds a violation.
void	setDefinitionFile(java.io.File definitionFile) Sets a custom naming convention definition file.
void	setFailBuild(boolean failBuild) Sets if the build should fail if the watch dog finds a violation.
void	setPlaceholderValues(java.util.Map<java.lang.String,java.lang.String> placeholderValues) Sets custom the placeholder values.
void	setSourceDirs(java.util.Set<java.io.File> sourceDirs) Sets custom source directories.

Methods inherited from class java.lang.Object

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

Constructor Detail

FileNamingWatchDogExtension

public FileNamingWatchDogExtension(org.gradle.api.Project project)

Instantiates a new file naming watch dog extension.

Parameters:

project - the project

Method Detail

getDefinitionFile

public java.io.File getDefinitionFile()

Gets the naming convention definition file.

Returns:

the naming convention definition file

setDefinitionFile

public void setDefinitionFile(java.io.File definitionFile)

Sets a custom naming convention definition file.

Parameters:

definitionFile - the new definition file

getPlaceholderValues

public java.util.Map<java.lang.String,java.lang.String> getPlaceholderValues()

Gets the placeholder values to be used for the naming convention definition file.

Returns:

the placeholder values

setPlaceholderValues

public void setPlaceholderValues(java.util.Map<java.lang.String,java.lang.String> placeholderValues)

Sets custom the placeholder values.

Parameters:

placeholderValues - the placeholder values

getSourceDirs

public java.util.Set<java.io.File> getSourceDirs()

Gets the source directories to scan with the watch dog.

Returns:

the source directories

setSourceDirs

public void setSourceDirs(java.util.Set<java.io.File> sourceDirs)

Sets custom source directories.

Parameters:

sourceDirs - the new source directories

isFailBuild

public boolean isFailBuild()

Checks if the build should fail if the watch dog finds a violation.

Returns:

true, if the build should fail, false otherwise

setFailBuild

public void setFailBuild(boolean failBuild)

Sets if the build should fail if the watch dog finds a violation.

Parameters:

failBuild - true if the build should fail, false otherwise