net.sourceforge.pldoc.cpd

Class CPD

java.lang.Object

net.sourceforge.pldoc.cpd.CPD

public class CPD
extends Object

PL/SQL CPD documentation generator.

Author:

Stuart Turton

Field Summary

Fields

Modifier and Type	Field and Description
Settings	settings

Constructor Summary

Constructors

Constructor and Description
CPD(Settings settings) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	add(File file)
void	add(List<File> files)
void	addAllInDirectory(String dir)
void	addRecursively(String dir)
Iterator<net.sourceforge.pmd.cpd.Match>	getMatches()
void	go() Execute the search for all loaded source code.
static void	main(String[] args) Test/run this from the command line.
void	run() Search the attached source code using the current settings.
void	setCpdListener(net.sourceforge.pmd.cpd.CPDListener cpdListener) Set up monitoring of source code for similarities.

Methods inherited from class java.lang.Object

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

Field Detail

settings

public Settings settings

Constructor Detail

CPD

public CPD(Settings settings)

Constructor.

Parameters:

settings - CPD settings passin from Maven mojo.

Method Detail

main

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

Test/run this from the command line.

Parameters:

args - commandpline

Throws:

Exception - on error

run

public void run()
         throws Exception

Search the attached source code using the current settings.

Throws:

Exception - on error

setCpdListener

public void setCpdListener(net.sourceforge.pmd.cpd.CPDListener cpdListener)

Set up monitoring of source code for similarities.

Parameters:

cpdListener - Track source code files.

go

public void go()

Execute the search for all loaded source code.

getMatches

public Iterator<net.sourceforge.pmd.cpd.Match> getMatches()

add

public void add(File file)
         throws IOException

Throws:

IOException

addAllInDirectory

public void addAllInDirectory(String dir)
                       throws IOException

Throws:

IOException

addRecursively

public void addRecursively(String dir)
                    throws IOException

Throws:

IOException

add

public void add(List<File> files)
         throws IOException

Throws:

IOException