synapticloop.copyrightr.plugin

Class CopyrightrPluginExtension

java.lang.Object

synapticloop.copyrightr.plugin.CopyrightrPluginExtension

public class CopyrightrPluginExtension
extends Object

Constructor Summary

Constructors

Constructor and Description
CopyrightrPluginExtension()

Method Summary

Modifier and Type	Method and Description
String	getCopyrightHolder() Get the copyright holder (defaults to an empty string "")
boolean	getDryRun() Return whether this operation is a dry run - i.e.
List<String>	getExcludes() Return the list of exclusion patterns
boolean	getFailOnMissing() Get whether to fail on missing copyright information
List<String>	getIncludes() Get the list of inclusion patterns
boolean	getOnlyReplaceFirst() Get whether we should only replace the first found instance in a file, (default true)
String	getYearSeparator() Get the separator for year ranges (default ' - '), e.g.
void	setCopyrightHolder(String copyrightHolder) 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.
void	setDryRun(boolean dryRun) Set whether this operation should be a dry run - i.e.
void	setExcludes(List<String> excludes) Set the list of exclusion patterns
void	setFailOnMissing(boolean failOnMissing) Set whether to fail the build on missing copyright notification
void	setIncludes(List<String> includes) Set the list of inclusion patterns
void	setOnlyReplaceFirst(boolean onlyReplaceFirst) Set whether we should only replace the first found instance in a file
void	setYearSeparator(String yearSeparator) Set the separator for year ranges (default ' - '), e.g.

Methods inherited from class java.lang.Object

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

Constructor Detail

CopyrightrPluginExtension

public CopyrightrPluginExtension()

Method Detail

getExcludes

public List<String> getExcludes()

Return the list of exclusion patterns

Returns:

the list of the exclusion patterns

setExcludes

public void setExcludes(List<String> excludes)

Set the list of exclusion patterns

Parameters:

excludes - the list of exclusion patterns

getIncludes

public List<String> getIncludes()

Get the list of inclusion patterns

Returns:

the list of inclusion patterns

setIncludes

public void setIncludes(List<String> includes)

Set the list of inclusion patterns

Parameters:

includes - the list of inclusion patterns

getDryRun

public boolean getDryRun()

Return whether this operation is a dry run - i.e. does not change the files, just logs what would have been changed (default false)

Returns:

whether this operation is a dry run operation (default false)

setDryRun

public void setDryRun(boolean dryRun)

Set whether this operation should be a dry run - i.e. does not change the files, just logs what would have changed.

Parameters:

dryRun - whether this operation is a dry run operation

getOnlyReplaceFirst

public boolean getOnlyReplaceFirst()

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

Returns:

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

setOnlyReplaceFirst

public void setOnlyReplaceFirst(boolean onlyReplaceFirst)

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

Parameters:

onlyReplaceFirst - whether we should only replace the first found instance

getCopyrightHolder

public String getCopyrightHolder()

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

Returns:

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

setCopyrightHolder

public void setCopyrightHolder(String copyrightHolder)

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.

Parameters:

copyrightHolder - the copyright holder to set

getYearSeparator

public String getYearSeparator()

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

Returns:

the separator for year ranges

setYearSeparator

public void setYearSeparator(String yearSeparator)

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

Parameters:

yearSeparator - the separator to place between years

setFailOnMissing

public void setFailOnMissing(boolean failOnMissing)

Set whether to fail the build on missing copyright notification

Parameters:

failOnMissing - whether to fail the build on missing copyright information

getFailOnMissing

public boolean getFailOnMissing()

Get whether to fail on missing copyright information

Returns:

whether to fail on missing copyright information