net.sourceforge.pldoc.cpd.ant
Class PLDocCPDTask

java.lang.Object
  extended by org.apache.tools.ant.ProjectComponent
      extended by org.apache.tools.ant.Task
          extended by net.sourceforge.pldoc.cpd.ant.PLDocCPDTask
All Implemented Interfaces:
Cloneable

public class PLDocCPDTask
extends org.apache.tools.ant.Task

PLDoc CPD Ant Task

To define task in project:

   <taskdef
     name="pldoc"
     classname="net.sourceforge.pldoc.cpd.ant.PLDocCPDTask"
     classpath="pldoc-pmd-plugin.jar" />
 

To use:

   <pldoc-cpd
     verbose = "yes" | "no" (default: "no")
     destdir = dir-path
     stylesheet = file-path (default: stylesheet from library)
     inputEncoding = encoding (default: OS dependant) >
     language = expected language (default: plsql) >
     format = results format (default: text) >
     inputEncoding = encoding (default: OS dependant) >
     ignoreComments = (false | true) 
     ignoreIdentifiers = (false | true) 
     ignoreLiterals = (false | true) 
     minimumtokens =  integer
     showSkippedPackages = (false | true) 
     url = text
     user = text
     password = text
     types = text
     sql = text
     <!-- fileset+ -->
     </pldoc>
     driverName = text
     getMetadataStatement = text
     returntype = integer
 

Where:

destdir
Directory to store documentation files (created if doesn't exist)
stylesheet
File with CSS-stylesheet for the result documentation. If omitted, default CSS will be used.
inputEncoding
Input files encoding
language
expected language
format
output format
ignoreComments
true if comment contents should be ignored when checking for matches.
ignoreIdentifiers
true if object/variable names should be ignored when checking for matches.
ignoreLiterals
true if character, string and numeric literal values should be ignored when checking for matches.
minimumtokens
minimum number of tokens that constitues a match.
showSkippedPackages
Display list of packages which failed to parse
driverName
JDBC driver class to use to connect to the database
url
Database connection URL
user
Database username
password
Database password
types
Comma separated list of database types to parse from the database
sql
Comma separated list of database objects to parse from the database
fileset
Specifies files to be parsed. See Ant FileSet for more details.
getMetadataStatement
Callable statement to retrieve source text for each object, in this form "' ? = call GET_SOURCE( ? , ? , ? , ? , ? , ? ) '"
getMetadataStatementReturnType
integer equal to java.sql.Types constant of the the object type returned by getMetadataStatement


Field Summary
 
Fields inherited from class org.apache.tools.ant.Task
target, taskName, taskType, wrapper
 
Fields inherited from class org.apache.tools.ant.ProjectComponent
description, location, project
 
Constructor Summary
PLDocCPDTask()
           
 
Method Summary
 void addFileset(org.apache.tools.ant.types.FileSet fset)
           
 org.apache.tools.ant.types.Path createAuxClasspath()
           
 org.apache.tools.ant.types.Path createClasspath()
           
 void execute()
           
 org.apache.tools.ant.types.Path getAuxClasspath()
           
 org.apache.tools.ant.types.Path getClasspath()
           
 void setAuxClasspath(org.apache.tools.ant.types.Path auxClasspath)
           
 void setAuxClasspathRef(org.apache.tools.ant.types.Reference r)
           
 void setClasspath(org.apache.tools.ant.types.Path classpath)
           
 void setClasspathRef(org.apache.tools.ant.types.Reference r)
           
 void setDbPassword(String dbPassword)
           
 void setDbUrl(String dbUrl)
           
 void setDbUser(String dbUser)
           
 void setDestdir(File dir)
           
 void setDoctitle(String doctitle)
           
 void setDriverName(String driverName)
           
 void setExitOnError(boolean exitOnError)
           
 void setFormat(String format)
           
 void setGetMetadataStatement(String getMetadataStatement)
           
 void setIgnoreComments(boolean ignoreComments)
           
 void setIgnoreIdentifiers(boolean ignoreIdentifiers)
           
 void setIgnoreLiterals(boolean ignoreLiterals)
           
 void setInputEncoding(String enc)
           
 void setInputObjects(String inputObjects)
           
 void setInputTypes(String inputTypes)
           
 void setLanguage(String language)
           
 void setMinimumTokens(Integer minimumTokens)
           
 void setOutputFile(File file)
           
 void setReturnType(Integer getMetadataStatementReturnType)
           
 void setShowSkippedPackages(boolean showSkippedPackages)
           
 void setStylesheet(File file)
           
 void setVerbose(boolean verbose)
           
 
Methods inherited from class org.apache.tools.ant.Task
bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
 
Methods inherited from class org.apache.tools.ant.ProjectComponent
clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PLDocCPDTask

public PLDocCPDTask()
Method Detail

setClasspath

public void setClasspath(org.apache.tools.ant.types.Path classpath)

getClasspath

public org.apache.tools.ant.types.Path getClasspath()

createClasspath

public org.apache.tools.ant.types.Path createClasspath()

setClasspathRef

public void setClasspathRef(org.apache.tools.ant.types.Reference r)

setAuxClasspath

public void setAuxClasspath(org.apache.tools.ant.types.Path auxClasspath)

getAuxClasspath

public org.apache.tools.ant.types.Path getAuxClasspath()

createAuxClasspath

public org.apache.tools.ant.types.Path createAuxClasspath()

setAuxClasspathRef

public void setAuxClasspathRef(org.apache.tools.ant.types.Reference r)

setVerbose

public void setVerbose(boolean verbose)

setDestdir

public void setDestdir(File dir)

setDoctitle

public void setDoctitle(String doctitle)

setOutputFile

public void setOutputFile(File file)

addFileset

public void addFileset(org.apache.tools.ant.types.FileSet fset)

setStylesheet

public void setStylesheet(File file)

setInputEncoding

public void setInputEncoding(String enc)

setExitOnError

public void setExitOnError(boolean exitOnError)

setDbUrl

public void setDbUrl(String dbUrl)

setDbUser

public void setDbUser(String dbUser)

setDbPassword

public void setDbPassword(String dbPassword)

setInputObjects

public void setInputObjects(String inputObjects)

setInputTypes

public void setInputTypes(String inputTypes)

setShowSkippedPackages

public void setShowSkippedPackages(boolean showSkippedPackages)

setLanguage

public void setLanguage(String language)

setFormat

public void setFormat(String format)

setIgnoreComments

public void setIgnoreComments(boolean ignoreComments)

setIgnoreIdentifiers

public void setIgnoreIdentifiers(boolean ignoreIdentifiers)

setIgnoreLiterals

public void setIgnoreLiterals(boolean ignoreLiterals)

setMinimumTokens

public void setMinimumTokens(Integer minimumTokens)

setDriverName

public void setDriverName(String driverName)

setGetMetadataStatement

public void setGetMetadataStatement(String getMetadataStatement)

setReturnType

public void setReturnType(Integer getMetadataStatementReturnType)

execute

public void execute()
             throws org.apache.tools.ant.BuildException
Overrides:
execute in class org.apache.tools.ant.Task
Throws:
org.apache.tools.ant.BuildException


Copyright © 2012. All Rights Reserved.