A C G I P S

A

apply(Project) - Method in class synapticloop.copyrightr.plugin.CopyrightrPlugin

C

CopyrightrException - Exception in synapticloop.copyrightr.exception

CopyrightrException(String) - Constructor for exception synapticloop.copyrightr.exception.CopyrightrException

CopyrightrException(Throwable) - Constructor for exception synapticloop.copyrightr.exception.CopyrightrException

CopyrightrException(String, Throwable) - Constructor for exception synapticloop.copyrightr.exception.CopyrightrException

CopyrightrException(String, Throwable, boolean, boolean) - Constructor for exception synapticloop.copyrightr.exception.CopyrightrException

CopyrightrPlugin - Class in synapticloop.copyrightr.plugin

CopyrightrPlugin() - Constructor for class synapticloop.copyrightr.plugin.CopyrightrPlugin

CopyrightrPluginExtension - Class in synapticloop.copyrightr.plugin

CopyrightrPluginExtension() - Constructor for class synapticloop.copyrightr.plugin.CopyrightrPluginExtension

CopyrightrTask - Class in synapticloop.copyrightr.plugin

CopyrightrTask() - Constructor for class synapticloop.copyrightr.plugin.CopyrightrTask

Instantiate the task, setting the group and description

G

generate() - Method in class synapticloop.copyrightr.plugin.CopyrightrTask

getCopyrightHolder() - Method in class synapticloop.copyrightr.plugin.CopyrightrPluginExtension

Get the copyright holder (defaults to an empty string "")

getDryRun() - Method in class synapticloop.copyrightr.plugin.CopyrightrPluginExtension

Return whether this operation is a dry run - i.e.

getExcludes() - Method in class synapticloop.copyrightr.plugin.CopyrightrPluginExtension

Return the list of exclusion patterns

getFailOnMissing() - Method in class synapticloop.copyrightr.plugin.CopyrightrPluginExtension

Get whether to fail on missing copyright information

getIncludes() - Method in class synapticloop.copyrightr.plugin.CopyrightrPluginExtension

Get the list of inclusion patterns

getMissingFiles() - Method in class synapticloop.copyrightr.bean.Statistics

Get the list of files that are missing the copyright notice

getNotUpdatedFiles() - Method in class synapticloop.copyrightr.bean.Statistics

Get the list of files that were not updated

getNumFiles() - Method in class synapticloop.copyrightr.bean.Statistics

Get the total number of files scanned

getNumFound() - Method in class synapticloop.copyrightr.bean.Statistics

Get the number of copyright notices found

getNumMissing() - Method in class synapticloop.copyrightr.bean.Statistics

Get the number of missing copyright notices

getNumNotUpdated() - Method in class synapticloop.copyrightr.bean.Statistics

Get the number of files that were not updated

getNumUpdated() - Method in class synapticloop.copyrightr.bean.Statistics

Get the number of files that were updated

getOnlyReplaceFirst() - Method in class synapticloop.copyrightr.plugin.CopyrightrPluginExtension

Get whether we should only replace the first found instance in a file, (default true)

getUpdatedFiles() - Method in class synapticloop.copyrightr.bean.Statistics

Get the list of files that were updated

getYearSeparator() - Method in class synapticloop.copyrightr.plugin.CopyrightrPluginExtension

Get the separator for year ranges (default ' - '), e.g.

I

incrementNumFiles() - Method in class synapticloop.copyrightr.bean.Statistics

increment the number of files

incrementNumFound() - Method in class synapticloop.copyrightr.bean.Statistics

increment the number of files with copyright notices found

incrementNumMissing(String) - Method in class synapticloop.copyrightr.bean.Statistics

increment the number of files with copyright notices missing

incrementNumNotUpdated(String) - Method in class synapticloop.copyrightr.bean.Statistics

increment the number of files that the copyright was not updated

incrementNumUpdated(String) - Method in class synapticloop.copyrightr.bean.Statistics

increment the number of files that the copyright was updated

P

parse() - Method in class synapticloop.copyrightr.Parser

Parse the files, looking for the copyright notice, then print out a summary, if the failOnMissing flag is set and there are missing copyright notices, the build will fail.

Parser - Class in synapticloop.copyrightr

This is the main parser file which will go through each of the files, search for the copyright string and (optionally) replace the line in the file.

Parser(Project, CopyrightrPluginExtension) - Constructor for class synapticloop.copyrightr.Parser

Create a new parser object which will loop through the lines of the file looking for copyright notices and (potentially) update them

S

setCopyrightHolder(String) - Method in class synapticloop.copyrightr.plugin.CopyrightrPluginExtension

Set the copyright holder - which will be appended to the regex string to give greater control over the regex to only look for the copyright line that ends with the name of the copyright holder.

setDryRun(boolean) - Method in class synapticloop.copyrightr.plugin.CopyrightrPluginExtension

Set whether this operation should be a dry run - i.e.

setExcludes(List<String>) - Method in class synapticloop.copyrightr.plugin.CopyrightrPluginExtension

Set the list of exclusion patterns

setFailOnMissing(boolean) - Method in class synapticloop.copyrightr.plugin.CopyrightrPluginExtension

Set whether to fail the build on missing copyright notification

setIncludes(List<String>) - Method in class synapticloop.copyrightr.plugin.CopyrightrPluginExtension

Set the list of inclusion patterns

setOnlyReplaceFirst(boolean) - Method in class synapticloop.copyrightr.plugin.CopyrightrPluginExtension

Set whether we should only replace the first found instance in a file

setYearSeparator(String) - Method in class synapticloop.copyrightr.plugin.CopyrightrPluginExtension

Set the separator for year ranges (default ' - '), e.g.

Statistics - Class in synapticloop.copyrightr.bean

This is a simple Bean that holds the statistics for all of the information about the files that were searched and parsed.

Statistics() - Constructor for class synapticloop.copyrightr.bean.Statistics

synapticloop.copyrightr - package synapticloop.copyrightr

synapticloop.copyrightr.bean - package synapticloop.copyrightr.bean

synapticloop.copyrightr.exception - package synapticloop.copyrightr.exception

synapticloop.copyrightr.plugin - package synapticloop.copyrightr.plugin

A C G I P S