|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.mkdoc.util.SourceList
Generate a source file listing from a root directory.
Traverses all Java source files and directories under a given location and creates a one file path per line output stream. The output can be directed to a file.
The source file listing is designed to be used as input for the GNU compiler for Java, GCJ.
Constructor Summary | |
private |
SourceList()
Private default constructor. |
Method Summary | |
private static boolean |
canReadDirectory(java.io.File directory)
Check a directory exists and is readable. |
private static boolean |
canWriteDirectory(java.io.File directory)
Check a directory exists and is writeable. |
private static boolean |
canWriteFile(java.io.File file)
Check a file could be written. |
private static void |
invalidDirectory(java.io.File directory)
Report an invalid base directory to standard error. |
private static void |
invalidFile(java.io.File file)
Report an invalid output file to standard error. |
static void |
main(java.lang.String[] args)
Generate a source listing for a base directory. |
private static void |
printUsage(java.io.PrintStream out)
Print standard command line usage. |
private static void |
writeList(java.io.File baseDir,
java.io.PrintStream out)
Write a source listing to the output stream. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
private SourceList()
Method Detail |
public static final void main(java.lang.String[] args) throws java.io.IOException
If the output file already exists, it will be overwritten.
args
- The first argument is the base
directory to start from. The second
argument is the output file name.
java.io.IOException
- If there is a problem
writing to the selected output.private static final void writeList(java.io.File baseDir, java.io.PrintStream out) throws java.io.IOException
Method calls recursively on all child directories.
baseDir
- An initial directory to work from.
All source and directories beneath will be
listed.out
- An output stream to write the list to.
java.io.IOException
- If there is a problem
writing to the specified output, or closing
the stream.private static final void printUsage(java.io.PrintStream out)
out
- Either System.err
or
System.out
, depending on
context.private static final boolean canReadDirectory(java.io.File directory)
directory
- A file system directory
reference.
true
if the referenced file
system object exists, is a directory and
has read permission.private static final boolean canWriteDirectory(java.io.File directory)
directory
- A file system directory
reference.
true
if the referenced file
system object exists, is a directory and
has write permission.private static final boolean canWriteFile(java.io.File file)
file
- A file reference.
true
if the file has a valid
parent directory that has write permission.private static final void invalidDirectory(java.io.File directory)
directory
- An invalid File
reference.private static final void invalidFile(java.io.File file)
file
- An invalid File
reference.
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |