org.glassfish.copyright

Class TextCopyright

java.lang.Object

org.glassfish.copyright.AbstractCopyright

org.glassfish.copyright.TextCopyright

public class TextCopyright
extends AbstractCopyright

Field Summary

Fields inherited from class org.glassfish.copyright.AbstractCopyright

allrights, c, thisYear, ylpat, ylpat_YEAR, ypat, ypat_YEAR, ytpat

Constructor Summary

Constructors

Constructor and Description
TextCopyright(Copyright c)

Method Summary

Modifier and Type	Method and Description
protected boolean	matches(java.util.regex.Pattern pat, java.lang.String s) Does the string match the pattern? Since we don't know where the comment text might end, we just insist that it match starting at the beginning of the text.
protected java.lang.String	readComment(java.io.BufferedReader r) Read the first comment block in a non-Java file.
protected void	repair(java.io.File file, java.lang.String comment, org.glassfish.copyright.AbstractCopyright.RepairType type) Repair the c.errors in the file.
protected 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 boolean	supports(java.io.File file) Is this a plain text file?
protected java.lang.String	toComment(java.lang.String comment) Convert the comment text to the appropriate syntax.
protected 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.

Methods inherited from class org.glassfish.copyright.AbstractCopyright

addCopyrightDate, checkCopyright, copy, err, findPrefix, fixCopyright, fixCopyright, getCopyrights, isModified, lastChanged, matches, startsWith, startsWith, strip, warnCopyright, writeCopyright

Methods inherited from class java.lang.Object

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

Constructor Detail

TextCopyright

public TextCopyright(Copyright c)

Method Detail

supports

protected boolean supports(java.io.File file)

Is this a plain text file?

Specified by:

supports in class AbstractCopyright

readComment

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

Read the first comment block in a non-Java file. Don't know how to do this so just return up to the first 100 lines.

Specified by:

readComment in class AbstractCopyright

Throws:

java.io.IOException

matches

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

Does the string match the pattern? Since we don't know where the comment text might end, we just insist that it match starting at the beginning of the text.

Overrides:

matches in class AbstractCopyright

repair

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

Repair the c.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.

Overrides:

repair in class AbstractCopyright

Throws:

java.io.IOException

replaceCopyright

protected 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.

Specified by:

replaceCopyright in class AbstractCopyright

Throws:

java.io.IOException

updateCopyright

protected 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.

Specified by:

updateCopyright in class AbstractCopyright

Throws:

java.io.IOException

toComment

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

Convert the comment text to the appropriate syntax.

Specified by:

toComment in class AbstractCopyright