com.marcusman.packageify

Class Packageify

java.lang.Object

com.marcusman.packageify.Packageify

public class Packageify
extends java.lang.Object

Packageify puts files that were originally all in the same folder in organized packages based on input information.

 Program arguments:
 (path to folder with all java files) (package definition txt file) (output folder)
 
 Example of package definition file:
 AnimatedSprite;com.marcusman.graphics
 Game;com.marcusman
 GameObject;com.marcusman.utils
 GUI;com.marcusman.graphics.gui
 GUIButton;com.marcusman.graphics.gui
 KeyBoardListener;com.marcusman.input
 Map;com.marcusman.logic
 MouseEventListener;com.marcusman.input
 Player;com.marcusman.logic
 Rectangle;com.marcusman.utils
 RenderHandler;com.marcusman.graphics
 SDKButton;com.marcusman.graphics.gui
 Sprite;com.marcusman.graphics
 SpriteSheet;com.marcusman.graphics
 Tiles;com.marcusman.logic
 

Field Summary

Fields

Modifier and Type	Field and Description
private java.io.File	definitionFile
private java.io.File	inputFolder
private java.io.File	outputFolder
private java.util.ArrayList<PackagedFile>	packagedFiles

Constructor Summary

Constructors

Constructor and Description
Packageify(java.lang.String[] args) Packageify the given directory with the description given above.

Method Summary

Modifier and Type	Method and Description
private void	copyNonJavaFiles() Copy all non-java files from the inputDir to the outputDir.
private void	createPackagedFilesList() Initialize and fill in our packagedFiles ArrayList with the information provided in the individual lines of the definition file.
private java.lang.String	getPackagedImports(PackagedFile consideredFile, java.lang.String fileString) Find the usage of other packaged files in this one and return a string of imports if any given packaged file is in use.
static void	main(java.lang.String[] args)
private void	putFilesIntoPackageFolders() Copy all of the java files in the input directory into the output directory under their package directories and put the package definition at the top of the file.
private void	validateFiles() Validate that all 3 files and directories (inputFolder, definitionFile, and outputFile) exist or are accessible.

Methods inherited from class java.lang.Object

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

Field Detail

inputFolder

private java.io.File inputFolder

definitionFile

private java.io.File definitionFile

outputFolder

private java.io.File outputFolder

packagedFiles

private java.util.ArrayList<PackagedFile> packagedFiles

Constructor Detail

Packageify

public Packageify(java.lang.String[] args)
           throws java.lang.Exception

Packageify the given directory with the description given above.

Parameters:

args - args[0] = inputFolder args[1] = definitionFile args[2] = outputFolder.

Throws:

java.lang.Exception - which could be IOException or IllegalArgumentException

Method Detail

copyNonJavaFiles

private void copyNonJavaFiles()
                       throws java.io.IOException

Copy all non-java files from the inputDir to the outputDir.

Throws:

java.io.IOException - if inputFile doesn't exist or copying goes awry.

putFilesIntoPackageFolders

private void putFilesIntoPackageFolders()
                                 throws java.io.IOException

Copy all of the java files in the input directory into the output directory under their package directories and put the package definition at the top of the file. Also try to add imports to other classes that have been packageified if they are found to be used in this class.

Throws:

java.io.IOException - if there was a problem reading, writing, or copying files.

getPackagedImports

private java.lang.String getPackagedImports(PackagedFile consideredFile,
                                            java.lang.String fileString)

Find the usage of other packaged files in this one and return a string of imports if any given packaged file is in use.

Parameters:

consideredFile - The packaged file we are considering.

fileString - The packaged file we are considering in string form.

Returns:

a string with \n separated import statements.

createPackagedFilesList

private void createPackagedFilesList()
                              throws java.io.IOException

Initialize and fill in our packagedFiles ArrayList with the information provided in the individual lines of the definition file.

Throws:

java.io.IOException - if there is a formatting problem with the file or a read error.

validateFiles

private void validateFiles()

Validate that all 3 files and directories (inputFolder, definitionFile, and outputFile) exist or are accessible.

main

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

Throws:

java.lang.Exception