net.sourceforge.pldoc.cpd
Class Settings

java.lang.Object
  extended by net.sourceforge.pldoc.cpd.Settings

public class Settings
extends Object

Represents all settings for the program. Setting values may be received from command line options and/or defaulted. This class should not have side effects.

Author:
Stuart Turton

Field Summary
static String CPD_LANGUAGE_DEFAULT
           
static int CPD_MINIMUM_TOKENS_DEFAULT
           
static String CPD_RENDER_FORMAT_DEFAULT
           
 
Constructor Summary
Settings()
           
 
Method Summary
 FilenameFilter filenameFilter()
           
 void generateHtml(File outputFile)
          Generates HTML file from the provided XML file and the specified stylesheet.
 String getApplicationName()
           
 String getDbPassword()
           
 String getDbUrl()
           
 String getDbUser()
           
 Properties getDefines()
           
 String getDriverName()
           
 String getFormatString()
           
 String getGetMetadataStatement()
           
 String getInputEncoding()
           
 Collection getInputFiles()
           
 Collection getInputObjects()
           
 Collection getInputTypes()
           
 net.sourceforge.pmd.cpd.Language getLanguage()
           
 String getLanguageString()
           
 int getMinimumTileSize()
           
 File getOutputDirectory()
           
 File getOutputFile()
           
 net.sourceforge.pmd.cpd.Renderer getRenderer()
           
static net.sourceforge.pmd.cpd.Renderer getRendererFromString(String name)
           
 int getReturnType()
           
 File getStylesheet()
           
 boolean ignoreComments()
           
 boolean ignoreIdentifiers()
           
 boolean ignoreLiterals()
           
 boolean isExitOnError()
           
 boolean isShowSkippedPackages()
           
 boolean isVerbose()
           
 net.sourceforge.pmd.cpd.Language language()
           
 int minimumTileSize()
           
 void processCommandString(String[] args)
          Consumes command line strings received by the main() method
 net.sourceforge.pmd.cpd.Renderer renderer()
           
 void setApplicationName(String applicationName)
           
 void setDbPassword(String dbPassword)
           
 void setDbUrl(String dbUrl)
           
 void setDbUser(String dbUser)
           
 void setDefines(Properties defines)
           
 void setDriverName(String driverName)
           
 void setExitOnError(boolean exitOnError)
           
 void setFormat(net.sourceforge.pmd.cpd.Renderer renderer)
           
 void setFormat(String formatString)
           
 void setGetMetadataStatement(String getMetadataStatement)
           
 void setIgnoreComments(boolean flag)
           
 void setIgnoreIdentifiers(boolean flag)
           
 void setIgnoreLiterals(boolean flag)
           
 void setInputEncoding(String inputEncoding)
           
 void setInputFiles(Collection inputFiles)
           
 void setInputObjects(Collection inputObjects)
           
 void setInputTypes(Collection inputTypes)
           
 void setLanguage(net.sourceforge.pmd.cpd.Language language)
           
 void setLanguage(String languageString)
           
 void setMinimumTileSize(Integer minimumTileSize)
           
 void setOutputDirectory(File outputDirectory)
           
 void setOutputFile(File outputFile)
           
 void setOutputFile(String outputFileName)
           
 void setReturnType(int returnType)
           
 void setShowSkippedPackages(boolean showSkippedPackages)
           
 void setStylesheet(File stylesheetFile)
           
 void setStylesheet(String stylesheetName)
           
 void setVerbose(boolean verbose)
           
 boolean skipDuplicates()
           
 void skipDuplicates(boolean flag)
           
 net.sourceforge.pmd.cpd.SourceCode sourceCodeFor(File file)
           
 net.sourceforge.pmd.cpd.Tokenizer tokenizer()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

CPD_RENDER_FORMAT_DEFAULT

public static final String CPD_RENDER_FORMAT_DEFAULT
See Also:
Constant Field Values

CPD_LANGUAGE_DEFAULT

public static final String CPD_LANGUAGE_DEFAULT
See Also:
Constant Field Values

CPD_MINIMUM_TOKENS_DEFAULT

public static final int CPD_MINIMUM_TOKENS_DEFAULT
See Also:
Constant Field Values
Constructor Detail

Settings

public Settings()
Method Detail

processCommandString

public void processCommandString(String[] args)
                          throws Exception
Consumes command line strings received by the main() method

Throws:
Exception

setApplicationName

public void setApplicationName(String applicationName)

setOutputDirectory

public void setOutputDirectory(File outputDirectory)

setInputFiles

public void setInputFiles(Collection inputFiles)

setDefines

public void setDefines(Properties defines)

setInputEncoding

public void setInputEncoding(String inputEncoding)

setVerbose

public void setVerbose(boolean verbose)

setExitOnError

public void setExitOnError(boolean exitOnError)

setReturnType

public void setReturnType(int returnType)

setDriverName

public void setDriverName(String driverName)

setGetMetadataStatement

public void setGetMetadataStatement(String getMetadataStatement)

setDbUrl

public void setDbUrl(String dbUrl)

setDbUser

public void setDbUser(String dbUser)

setDbPassword

public void setDbPassword(String dbPassword)

setInputObjects

public void setInputObjects(Collection inputObjects)

setInputTypes

public void setInputTypes(Collection inputTypes)

setShowSkippedPackages

public void setShowSkippedPackages(boolean showSkippedPackages)

getApplicationName

public String getApplicationName()

getOutputDirectory

public File getOutputDirectory()

getInputFiles

public Collection getInputFiles()

getDefines

public Properties getDefines()

getInputEncoding

public String getInputEncoding()

isVerbose

public boolean isVerbose()

isExitOnError

public boolean isExitOnError()

getDbUrl

public String getDbUrl()

getGetMetadataStatement

public String getGetMetadataStatement()

getReturnType

public int getReturnType()

getDriverName

public String getDriverName()

getDbUser

public String getDbUser()

getDbPassword

public String getDbPassword()

getInputObjects

public Collection getInputObjects()

getInputTypes

public Collection getInputTypes()

isShowSkippedPackages

public boolean isShowSkippedPackages()

sourceCodeFor

public net.sourceforge.pmd.cpd.SourceCode sourceCodeFor(File file)

language

public net.sourceforge.pmd.cpd.Language language()

minimumTileSize

public int minimumTileSize()

skipDuplicates

public boolean skipDuplicates()

skipDuplicates

public void skipDuplicates(boolean flag)

ignoreComments

public boolean ignoreComments()

setLanguage

public void setLanguage(String languageString)

setLanguage

public void setLanguage(net.sourceforge.pmd.cpd.Language language)

getLanguage

public net.sourceforge.pmd.cpd.Language getLanguage()

setFormat

public void setFormat(String formatString)

setFormat

public void setFormat(net.sourceforge.pmd.cpd.Renderer renderer)

getRenderer

public net.sourceforge.pmd.cpd.Renderer getRenderer()

setIgnoreComments

public void setIgnoreComments(boolean flag)

ignoreIdentifiers

public boolean ignoreIdentifiers()

setIgnoreIdentifiers

public void setIgnoreIdentifiers(boolean flag)

ignoreLiterals

public boolean ignoreLiterals()

setIgnoreLiterals

public void setIgnoreLiterals(boolean flag)

getMinimumTileSize

public int getMinimumTileSize()

setMinimumTileSize

public void setMinimumTileSize(Integer minimumTileSize)

filenameFilter

public FilenameFilter filenameFilter()

tokenizer

public net.sourceforge.pmd.cpd.Tokenizer tokenizer()

renderer

public net.sourceforge.pmd.cpd.Renderer renderer()

getRendererFromString

public static net.sourceforge.pmd.cpd.Renderer getRendererFromString(String name)

setOutputFile

public void setOutputFile(String outputFileName)

setOutputFile

public void setOutputFile(File outputFile)

getOutputFile

public File getOutputFile()

setStylesheet

public void setStylesheet(String stylesheetName)

setStylesheet

public void setStylesheet(File stylesheetFile)

getStylesheet

public File getStylesheet()

getFormatString

public String getFormatString()

getLanguageString

public String getLanguageString()

generateHtml

public void generateHtml(File outputFile)
                  throws Exception
Generates HTML file from the provided XML file and the specified stylesheet.

Parameters:
applicationFile - XML application file
Throws:
Exception


Copyright © 2012. All Rights Reserved.