planetj.util
Class CopyrightGenerator

java.lang.Object
  planetj.util.CopyrightGenerator

public class CopyrightGenerator

extends java.lang.Object

Appends copyright info to .java files

Constructor Summary

CopyrightGenerator()

Method Summary

static void	getCopyrightText() Getst the complete copyright text to add/update
static java.lang.String	getProductName() Get the product name
static java.lang.String	getYear() Gets the current year
static void	main(java.lang.String[] args) Takes one or two arguments.
static void	updateCopyright(java.io.File origFile) Adds/updates the copyright text to a single file
static void	updateCopyright(java.lang.String path) Adds/updates the copyright text to a single file
static int	updateCopyrightInDirectory(java.io.File dir, boolean recursive) Updates the copyright in all the .java files in the directory
static int	updateCopyrightInDirectory(java.lang.String directory, boolean recursive) Updates the copyright in all the .java files in the directory
static void	writeCopyrightText(java.io.Writer w) Appends the complete copyright text to the writer

Methods inherited from class java.lang.Object

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

Constructor Detail

CopyrightGenerator

public CopyrightGenerator()

Method Detail

getCopyrightText

public static void getCopyrightText()

Getst the complete copyright text to add/update

getProductName

public static java.lang.String getProductName()

Get the product name

getYear

public static java.lang.String getYear()

Gets the current year

main

public static void main(java.lang.String[] args)

Takes one or two arguments. The first is the directory containing the .java files to modify, or a name of a single .java file to alter. The second argument (which is optional) is the name of the product to include in the copyright section

updateCopyright

public static void updateCopyright(java.io.File origFile)
                            throws java.io.IOException,
                                   CMException

Adds/updates the copyright text to a single file

Throws:

java.io.IOException

CMException

updateCopyright

public static void updateCopyright(java.lang.String path)
                            throws java.io.IOException,
                                   CMException

Adds/updates the copyright text to a single file

Throws:

java.io.IOException

CMException

updateCopyrightInDirectory

public static int updateCopyrightInDirectory(java.io.File dir,
                                             boolean recursive)
                                      throws CMException

Updates the copyright in all the .java files in the directory

Parameters:

dir - The directory

recursive - Whether the process should be repeated for subdirectories

Returns:

The number of updated files

Throws:

CMException

updateCopyrightInDirectory

public static int updateCopyrightInDirectory(java.lang.String directory,
                                             boolean recursive)
                                      throws CMException

Updates the copyright in all the .java files in the directory

Parameters:

directory - The path to the directory

recursive - Whether the process should be repeated for subdirectories

Returns:

The number of updated files

Throws:

CMException

writeCopyrightText

public static void writeCopyrightText(java.io.Writer w)
                               throws java.io.IOException

Appends the complete copyright text to the writer

Throws:

java.io.IOException