net.sourceforge.pldoc.cpd

Class CPDUtils

java.lang.Object

net.sourceforge.pldoc.cpd.CPDUtils

public class CPDUtils
extends Object

Utilities supporting the main functionality

Author:

Stuart Turton

Constructor Summary

Constructors

Constructor and Description
CPDUtils()

Method Summary

Methods

Modifier and Type	Method and Description
static void	copyStaticRootDirectoryFiles(File outputDirectory, File stylesheet, File sourceStylesheet) Copies required static files into the root output directory.
static void	copyStaticSourceDirectoryFiles(File outputDirectory, String relativePath) Copy required static files into the source code directory.
static InputStream	getBOMInputStream(InputStream inputStream, String inputEncoding) Return an InputStream, stripping out any BOM if the specified or default chracter encoding is UTF*.

Methods inherited from class java.lang.Object

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

Constructor Detail

CPDUtils

public CPDUtils()

Method Detail

copyStaticSourceDirectoryFiles

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

Copy 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 error

copyStaticRootDirectoryFiles

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

Copies required static files into the root output directory.

Parameters:

outputDirectory - directory to copy files

stylesheet - general CSS Stylesheet to format HTML pages

sourceStylesheet - general CSS Stylesheet to format source code HTML pages

Throws:

Exception - on error

getBOMInputStream

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

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

Parameters:

inputStream - Stream that may or may not contain a BOM

inputEncoding - file encoding of code in this InputStream

Returns:

InputSTream with any BOM stripped.

Throws:

IOException - on read error