org.glassfish.copyright

Class AbstractCopyrightMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.glassfish.copyright.AbstractCopyrightMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

Direct Known Subclasses:

CheckCopyrightMojo, CopyrightMojo, RepairCopyrightMojo

public abstract class AbstractCopyrightMojo
extends org.apache.maven.plugin.AbstractMojo

Check copyrights of files.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	alternateTemplateFile Alternate copyright template file.
protected java.io.File	baseDirectory Base directory for project.
protected java.lang.String	bsdTemplateFile Copyright BSD template file.
protected boolean	debug Turn on debugging.
protected boolean	doHidden Check hidden files too?
protected java.lang.String[]	exclude Exclude pattern list.
protected java.lang.String	excludeFile File(s) containing exclude patterns.
protected boolean	ignoreYear Don't check that the year is correct?
protected org.apache.maven.plugin.logging.Log	log Log output, initialize this in the execute method.
protected boolean	mavenOnly Check all files in project or just the source and resource files maven knows about?
protected boolean	normalize Normalize format of repaired copyright to match template?
protected boolean	preserveCopyrights Set to true to preserve original copyright entries.
protected java.util.ArrayList<org.apache.maven.model.Resource>	resources Resources.
protected java.lang.String	scm Select SCM system - svn (default), mercurial, git.
protected boolean	scmOnly Skip files not under SCM?
protected java.io.File	sourceDirectory Source directory.
protected java.lang.String	templateFile Copyright template file.
protected boolean	useComma Use comma instead of dash between years?
protected boolean	warn Turn off warnings.

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractCopyrightMojo()

Method Summary

Modifier and Type	Method and Description
protected void	check(Copyright c) Run the copyright checker using the specified options on the specified files in this project.
protected java.io.File	getResourceFile(java.lang.String resource) Get the File reference for a File passed in as a string reference.
protected void	initializeOptions(Copyright c) Initialize the Copyright object with the options from this mojo.

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.maven.plugin.Mojo

execute

Field Detail

excludeFile

protected java.lang.String excludeFile

File(s) containing exclude patterns.

This parameter is resolved as a resource, then a URL, then a file. This is a comma-separated list.

exclude

protected java.lang.String[] exclude

Exclude pattern list.

baseDirectory

protected java.io.File baseDirectory

Base directory for project. Should not need to be set.

sourceDirectory

protected java.io.File sourceDirectory

Source directory.

resources

protected java.util.ArrayList<org.apache.maven.model.Resource> resources

Resources.

mavenOnly

protected boolean mavenOnly

Check all files in project or just the source and resource files maven knows about?

scm

protected java.lang.String scm

Select SCM system - svn (default), mercurial, git.

debug

protected boolean debug

Turn on debugging.

warn

protected boolean warn

Turn off warnings.

ignoreYear

protected boolean ignoreYear

Don't check that the year is correct?

normalize

protected boolean normalize

Normalize format of repaired copyright to match template?

useComma

protected boolean useComma

Use comma instead of dash between years?

preserveCopyrights

protected boolean preserveCopyrights

Set to true to preserve original copyright entries.

scmOnly

protected boolean scmOnly

Skip files not under SCM?

doHidden

protected boolean doHidden

Check hidden files too?

templateFile

protected java.lang.String templateFile

Copyright template file.

alternateTemplateFile

protected java.lang.String alternateTemplateFile

Alternate copyright template file.

bsdTemplateFile

protected java.lang.String bsdTemplateFile

Copyright BSD template file.

log

protected org.apache.maven.plugin.logging.Log log

Log output, initialize this in the execute method.

Constructor Detail

AbstractCopyrightMojo

public AbstractCopyrightMojo()

Method Detail

initializeOptions

protected void initializeOptions(Copyright c)

Initialize the Copyright object with the options from this mojo.

check

protected void check(Copyright c)
              throws org.apache.maven.plugin.MojoExecutionException

Run the copyright checker using the specified options on the specified files in this project.

Throws:

org.apache.maven.plugin.MojoExecutionException

getResourceFile

protected java.io.File getResourceFile(java.lang.String resource)

Get the File reference for a File passed in as a string reference.

Parameters:

resource - The file for the resource manager to locate

Returns:

The File of the resource