org.glassfish.copyright

Class AbstractCopyright

java.lang.Object

org.glassfish.copyright.AbstractCopyright

Direct Known Subclasses:

BatCopyright, CommonCopyright, MarkdownCopyright, PropertiesCopyright, TextCopyright

public abstract class AbstractCopyright
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	allrights
protected Copyright	c
protected static java.lang.String	thisYear
protected static java.util.regex.Pattern	ylpat
protected static int	ylpat_YEAR
protected static java.util.regex.Pattern	ypat
protected static int	ypat_YEAR
protected static java.util.regex.Pattern	ytpat

Constructor Summary

Constructors

Constructor and Description
AbstractCopyright(Copyright c)

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	addCopyrightDate(java.lang.String date, java.lang.String lastChanged) Update the given copyright date to include the lastChanged date (assumed to be a date greater than any date included in "date").
protected void	checkCopyright(java.io.File file) Check a file for the correct copyright notice.
protected void	copy(java.io.BufferedReader in, java.io.BufferedWriter out, boolean skipBlanks) Copy "in" to "out", skipping blank lines at the beginning of "in" if skipBlanks is true, and canonicalizing the line terminators to '\n'.
protected void	err(java.lang.String s)
protected static java.lang.String	findPrefix(java.lang.String line) Find the prefix (if any) for the current line.
protected java.lang.String	fixCopyright(java.lang.String cr, java.util.List<java.lang.String> crs, java.lang.String date, java.lang.String lic) Update the copyright line in cr using the supplied copyright lines.
protected java.lang.String	fixCopyright(java.lang.String cr, java.lang.String date, java.lang.String lic) Update the copyright line in cr to use "date" as the copyright date and "lic" as the licensor.
protected java.util.List<java.lang.String>	getCopyrights(java.lang.String s) Get the copyright lines in the string.
protected boolean	isModified(java.lang.String file) Exec the "svn status" command to find out if the file has been modified locally.
protected java.lang.String	lastChanged(java.lang.String file) Exec the "svn info" command to get the date the file was last changed.
protected boolean	matches(java.util.List<java.util.regex.Pattern> patlist, java.lang.String s) Does the string match any of the patterns?
protected boolean	matches(java.util.regex.Pattern pat, java.lang.String s) Does the string match the pattern?
protected abstract java.lang.String	readComment(java.io.BufferedReader r) Read the first comment block in the file.
protected void	repair(java.io.File file, java.lang.String comment, org.glassfish.copyright.AbstractCopyright.RepairType type) Repair the errors in the file.
protected abstract void	replaceCopyright(java.io.BufferedReader in, java.io.BufferedWriter out, java.lang.String comment, java.lang.String lastChanged) Skip the first comment block, replacing it with the correct copyright.
protected static boolean	startsWith(java.io.File file, java.lang.String prefix) Does the file start with the specified prefix?
protected static boolean	startsWith(java.lang.String s, java.lang.String prefix) Like String.startsWith, but ignores case and skips leading whitespace.
protected static java.lang.String	strip(java.lang.String line) Strip any trailing whitespace.
protected abstract boolean	supports(java.io.File file) Does this class support this file? Subclasses will use the file name, and possibly examine the content of the file, to determine whether it's supported.
protected abstract java.lang.String	toComment(java.lang.String comment) Convert the comment text to the appropriate syntax.
protected abstract void	updateCopyright(java.io.BufferedReader in, java.io.BufferedWriter out, java.lang.String lastChanged) Update the existing copyright statement, changing the copyright year to include lastChanged.
protected void	warnCopyright(java.io.File file, java.io.BufferedReader in) Warn if there's another copyright statement in the file.
protected void	writeCopyright(java.io.BufferedWriter out, java.lang.String year, java.lang.String comment) Write the correct copyright to "out", using "year" as the copyright date.

Methods inherited from class java.lang.Object

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

Field Detail

c

protected Copyright c

ypat

protected static java.util.regex.Pattern ypat

ypat_YEAR

protected static final int ypat_YEAR

See Also:

Constant Field Values

ylpat

protected static java.util.regex.Pattern ylpat

ylpat_YEAR

protected static final int ylpat_YEAR

See Also:

Constant Field Values

ytpat

protected static java.util.regex.Pattern ytpat

allrights

protected static final java.lang.String allrights

See Also:

Constant Field Values

thisYear

protected static final java.lang.String thisYear

Constructor Detail

AbstractCopyright

public AbstractCopyright(Copyright c)

Method Detail

supports

protected abstract boolean supports(java.io.File file)

Does this class support this file? Subclasses will use the file name, and possibly examine the content of the file, to determine whether it's supported.

checkCopyright

protected void checkCopyright(java.io.File file)
                       throws java.io.IOException

Check a file for the correct copyright notice.

Throws:

java.io.IOException

matches

protected boolean matches(java.util.regex.Pattern pat,
                          java.lang.String s)

Does the string match the pattern?

matches

protected boolean matches(java.util.List<java.util.regex.Pattern> patlist,
                          java.lang.String s)

Does the string match any of the patterns?

repair

protected void repair(java.io.File file,
                      java.lang.String comment,
                      org.glassfish.copyright.AbstractCopyright.RepairType type)
               throws java.io.IOException

Repair the errors in the file. Repair cases and strategy: Missing copyright Insert correct copyright Wrong copyright Try to extract copyright date. Insert correct copyright. Wrong date Update existing date in existing copyright.

Throws:

java.io.IOException

writeCopyright

protected void writeCopyright(java.io.BufferedWriter out,
                              java.lang.String year,
                              java.lang.String comment)
                       throws java.io.IOException

Write the correct copyright to "out", using "year" as the copyright date. The original license may be supplied as "comment", from which a secondary license may be extracted, and which determines whether the new license is a BSD license or not.

Throws:

java.io.IOException

replaceCopyright

protected abstract void replaceCopyright(java.io.BufferedReader in,
                                         java.io.BufferedWriter out,
                                         java.lang.String comment,
                                         java.lang.String lastChanged)
                                  throws java.io.IOException

Skip the first comment block, replacing it with the correct copyright. If the file starts with a "package" statement, save it and write it out after the new copyright.

Throws:

java.io.IOException

updateCopyright

protected abstract void updateCopyright(java.io.BufferedReader in,
                                        java.io.BufferedWriter out,
                                        java.lang.String lastChanged)
                                 throws java.io.IOException

Update the existing copyright statement, changing the copyright year to include lastChanged.

Throws:

java.io.IOException

toComment

protected abstract java.lang.String toComment(java.lang.String comment)

Convert the comment text to the appropriate syntax.

readComment

protected abstract java.lang.String readComment(java.io.BufferedReader r)
                                         throws java.io.IOException

Read the first comment block in the file.

Throws:

java.io.IOException

warnCopyright

protected void warnCopyright(java.io.File file,
                             java.io.BufferedReader in)
                      throws java.io.IOException

Warn if there's another copyright statement in the file.

Throws:

java.io.IOException

copy

protected void copy(java.io.BufferedReader in,
                    java.io.BufferedWriter out,
                    boolean skipBlanks)
             throws java.io.IOException

Copy "in" to "out", skipping blank lines at the beginning of "in" if skipBlanks is true, and canonicalizing the line terminators to '\n'.

Throws:

java.io.IOException

addCopyrightDate

protected java.lang.String addCopyrightDate(java.lang.String date,
                                            java.lang.String lastChanged)

Update the given copyright date to include the lastChanged date (assumed to be a date greater than any date included in "date"). Return the updated date string.

getCopyrights

protected java.util.List<java.lang.String> getCopyrights(java.lang.String s)

Get the copyright lines in the string.

fixCopyright

protected java.lang.String fixCopyright(java.lang.String cr,
                                        java.lang.String date,
                                        java.lang.String lic)

Update the copyright line in cr to use "date" as the copyright date and "lic" as the licensor.

fixCopyright

protected java.lang.String fixCopyright(java.lang.String cr,
                                        java.util.List<java.lang.String> crs,
                                        java.lang.String date,
                                        java.lang.String lic)

Update the copyright line in cr using the supplied copyright lines. If one of the supplied copyright lines includes "lic" as the licensor, update it to use "date" as the copyright date.

strip

protected static java.lang.String strip(java.lang.String line)

Strip any trailing whitespace.

findPrefix

protected static java.lang.String findPrefix(java.lang.String line)

Find the prefix (if any) for the current line.

startsWith

protected static boolean startsWith(java.lang.String s,
                                    java.lang.String prefix)

Like String.startsWith, but ignores case and skips leading whitespace.

startsWith

protected static boolean startsWith(java.io.File file,
                                    java.lang.String prefix)

Does the file start with the specified prefix?

lastChanged

protected java.lang.String lastChanged(java.lang.String file)
                                throws java.io.IOException

Exec the "svn info" command to get the date the file was last changed.

Throws:

java.io.IOException

isModified

protected boolean isModified(java.lang.String file)
                      throws java.io.IOException

Exec the "svn status" command to find out if the file has been modified locally.

Throws:

java.io.IOException

err

protected void err(java.lang.String s)