org.glassfish.copyright

Class MarkdownCopyright

java.lang.Object

org.glassfish.copyright.AbstractCopyright

org.glassfish.copyright.MarkdownCopyright

public class MarkdownCopyright
extends AbstractCopyright

Field Summary

Fields

Modifier and Type	Field and Description
protected String	commentPrefix
protected String	commentSuffix

Fields inherited from class org.glassfish.copyright.AbstractCopyright

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

Constructor Summary

Constructors

Constructor and Description
MarkdownCopyright(Copyright c)

Method Summary

Modifier and Type	Method and Description
protected String	readComment(BufferedReader r) Read the first comment block in the file.
protected void	replaceCopyright(BufferedReader in, BufferedWriter out, String comment, String lastChanged) Skip the first comment block, replacing it with the correct copyright.
protected boolean	supports(File file) Is this a markdown file?
protected String	toComment(String comment) Convert the comment text to markdown syntax.
protected void	updateCopyright(BufferedReader in, BufferedWriter out, 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, guessLineTerminator, isModified, lastChanged, matches, matches, repair, startsWith, startsWith, strip, warnCopyright, writeCopyright

Methods inherited from class java.lang.Object

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

Field Detail

commentPrefix

protected String commentPrefix

commentSuffix

protected String commentSuffix

Constructor Detail

MarkdownCopyright

public MarkdownCopyright(Copyright c)

Method Detail

supports

protected boolean supports(File file)

Is this a markdown file?

Specified by:

supports in class AbstractCopyright

readComment

protected String readComment(BufferedReader r)
                      throws IOException

Read the first comment block in the file.

Specified by:

readComment in class AbstractCopyright

Throws:

IOException

replaceCopyright

protected void replaceCopyright(BufferedReader in,
                                BufferedWriter out,
                                String comment,
                                String lastChanged)
                         throws IOException

Skip the first comment block, replacing it with the correct copyright.

Specified by:

replaceCopyright in class AbstractCopyright

Throws:

IOException

updateCopyright

protected void updateCopyright(BufferedReader in,
                               BufferedWriter out,
                               String lastChanged)
                        throws IOException

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

Specified by:

updateCopyright in class AbstractCopyright

Throws:

IOException

toComment

protected String toComment(String comment)

Convert the comment text to markdown syntax.

Specified by:

toComment in class AbstractCopyright