net.sourceforge.pldoc

Class Utils

java.lang.Object

net.sourceforge.pldoc.Utils

public class Utils
extends Object

Utilities supporting the main functionality

Version:

$Header: /cvsroot/pldoc/sources/src/java/net/sourceforge/pldoc/Utils.java,v 1.3 2004/04/18 18:27:23 altumano Exp $

Author:

Albert Tumanov

Constructor Summary

Constructors

Constructor and Description
Utils()

Method Summary

Modifier and Type	Method and Description
static void	CopyFile(File inputFile, File outputFile) Copies a file.
static void	CopyFile(File inputFile, File outputFile, String resourceName) Copy a file with a fall back resource.
static void	CopyReaderToFile(Reader reader, File outputFile) Copies a Reader into a file.
static void	copyStaticRootDirectoryFiles(File outputDirectory, File stylesheet, File sourceStylesheet) Copy required static files into the root output directory.
static void	copyStaticSourceDirectoryFiles(File outputDirectory, String relativePath) Copies required static files into the source code directory.
static void	CopyStreamToFile(InputStream inputStream, File outputFile) Copies a InputStream into a file.
static InputStream	getBOMInputStream(InputStream inputStream, String inputEncoding) Return an InputStream, stripping out any BOM if the specified or default character encoding is UTF*.
static String	getStringFromInputStream(InputStream inputStream) Aggregate contents of an InputStream into a String

Methods inherited from class java.lang.Object

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

Constructor Detail

Utils

public Utils()

Method Detail

CopyFile

public static void CopyFile(File inputFile,
                            File outputFile,
                            String resourceName)
                     throws FileNotFoundException,
                            IOException

Copy a file with a fall back resource.

Parameters:

inputFile - source

outputFile - target

resourceName - - internal resource to use if inputFile does not exist

Throws:

FileNotFoundException - if the file does not exist

IOException - on input error

CopyFile

public static void CopyFile(File inputFile,
                            File outputFile)
                     throws FileNotFoundException,
                            IOException

Copies a file. I wish there was a standard Java way to do it.

Parameters:

inputFile - source

outputFile - target

Throws:

FileNotFoundException - if the file does not exist

IOException - on input error

CopyStreamToFile

public static void CopyStreamToFile(InputStream inputStream,
                                    File outputFile)
                             throws FileNotFoundException,
                                    IOException

Copies a InputStream into a file. I wish there was a standard Java way to do it.

Parameters:

inputStream - source

outputFile - target

Throws:

FileNotFoundException - if the file does not exist

IOException - on input error

CopyReaderToFile

public static void CopyReaderToFile(Reader reader,
                                    File outputFile)
                             throws FileNotFoundException,
                                    IOException

Copies a Reader into a file.

Parameters:

reader - source

outputFile - target

Throws:

FileNotFoundException - if the file does not exist

IOException - on input error

getStringFromInputStream

public static String getStringFromInputStream(InputStream inputStream)
                                       throws IOException

Aggregate contents of an InputStream into a String

Parameters:

inputStream - source

Returns:

aggregated contents

Throws:

IOException - on input error

copyStaticSourceDirectoryFiles

public static void copyStaticSourceDirectoryFiles(File outputDirectory,
                                                  String relativePath)
                                           throws Exception

Copies required static files into the source code directory. This allows the XSL and CSS hrefs to cope with relocation of the root output directory or access through a web browser.

Parameters:

outputDirectory - directory to copy files

relativePath - the relative path to the location of the root output directory

Throws:

Exception - on read or write error

copyStaticRootDirectoryFiles

public static void copyStaticRootDirectoryFiles(File outputDirectory,
                                                File stylesheet,
                                                File sourceStylesheet)
                                         throws Exception

Copy required static files into the root output directory.

Parameters:

outputDirectory - directory to copy files

stylesheet - explicit PLDoc CSS stylesheet

sourceStylesheet - explicit scraped source code CSS stylesheet

Throws:

Exception - on read or write error

getBOMInputStream

public static InputStream getBOMInputStream(InputStream inputStream,
                                            String inputEncoding)
                                     throws IOException

Return an InputStream, stripping out any BOM if the specified or default character encoding is UTF*.

Parameters:

inputStream - Stream that may or may not contain a BOM

inputEncoding - file encoding

Returns:

InputStream with any BOM stripped.

Throws:

IOException - on input error