net.sourceforge.pldoc

Class Settings

java.lang.Object

net.sourceforge.pldoc.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.

Version:

$Header: /cvsroot/pldoc/sources/src/java/net/sourceforge/pldoc/Settings.java,v 1.7 2005/11/29 08:25:00 gpaulissen Exp $

Author:

Albert Tumanov

Constructor Summary

Constructors

Constructor and Description
Settings()

Method Summary

Modifier and Type	Method and Description
String	getApplicationName()
String	getDbPassword()
String	getDbUrl()
String	getDbUser()
String	getDefaultKeywordscase()
String	getDefaultNamescase()
Properties	getDefines()
String	getDriverName()
String	getGetMetadataStatement()
String	getInputEncoding()
Collection	getInputFiles()
Collection	getInputObjects()
Collection	getInputTypes()
File	getOutputDirectory()
String	getOutputEncoding()
File	getOverviewFile()
int	getReturnType()
String	getSourceStylesheet()
InputStream	getSourceStylesheetFile()
String	getStylesheet()
InputStream	getStylesheetFile()
boolean	isExitOnError()
boolean	isIgnoreInformalComments()
boolean	isKeywordsDefaultcase()
boolean	isKeywordsLowercase()
boolean	isKeywordsUppercase()
boolean	isNamesDefaultcase()
boolean	isNamesLowercase()
boolean	isNamesUppercase()
boolean	isPlscope()
boolean	isSaveSourceCode()
boolean	isShowSkippedPackages()
boolean	isVerbose()
void	processCommandString(String[] args) Consume command line strings received by the main() method
void	setApplicationName(String applicationName)
void	setDbPassword(String dbPassword)
void	setDbUrl(String dbUrl)
void	setDbUser(String dbUser)
void	setDefaultKeywordscase(String defaultKeywordscase)
void	setDefaultNamescase(String defaultNamescase)
void	setDefines(Properties defines)
void	setDriverName(String driverName)
void	setExitOnError(boolean exitOnError)
void	setGetMetadataStatement(String getMetadataStatement)
void	setIgnoreInformalComments(boolean ignoreInformalComments)
void	setInputEncoding(String inputEncoding)
void	setInputFiles(Collection inputFiles)
void	setInputObjects(Collection inputObjects)
void	setInputTypes(Collection inputTypes)
void	setKeywordsDefaultcase(boolean keywordsDefaultcase)
void	setKeywordsLowercase(boolean keywordsLowercase)
void	setKeywordsUppercase(boolean keywordsUppercase)
void	setNamesDefaultcase(boolean namesDefaultcase)
void	setNamesLowercase(boolean namesLowercase)
void	setNamesUppercase(boolean namesUppercase)
void	setOutputDirectory(File outputDirectory)
void	setOverviewfile(File overviewfile)
void	setPlscope(boolean plscope)
void	setReturnType(int returnType)
void	setSaveSourceCode(boolean saveSourceCode)
void	setShowSkippedPackages(boolean showSkippedPackages)
void	setSourceStylesheetfile(String sourcestylesheetfile)
void	setStylesheetfile(String stylesheetfile)
void	setVerbose(boolean verbose)

Methods inherited from class java.lang.Object

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

Constructor Detail

Settings

public Settings()

Method Detail

processCommandString

public void processCommandString(String[] args)
                          throws Exception

Consume command line strings received by the main() method

Parameters:

args - array of command-line parameters.

Throws:

Exception - on error

setApplicationName

public void setApplicationName(String applicationName)

setOutputDirectory

public void setOutputDirectory(File outputDirectory)

setInputFiles

public void setInputFiles(Collection inputFiles)

setStylesheetfile

public void setStylesheetfile(String stylesheetfile)

setSourceStylesheetfile

public void setSourceStylesheetfile(String sourcestylesheetfile)

setOverviewfile

public void setOverviewfile(File overviewfile)

setDefines

public void setDefines(Properties defines)

setIgnoreInformalComments

public void setIgnoreInformalComments(boolean ignoreInformalComments)

setNamesDefaultcase

public void setNamesDefaultcase(boolean namesDefaultcase)

setNamesUppercase

public void setNamesUppercase(boolean namesUppercase)

setNamesLowercase

public void setNamesLowercase(boolean namesLowercase)

setDefaultNamescase

public void setDefaultNamescase(String defaultNamescase)

setDefaultKeywordscase

public void setDefaultKeywordscase(String defaultKeywordscase)

setKeywordsDefaultcase

public void setKeywordsDefaultcase(boolean keywordsDefaultcase)

setKeywordsUppercase

public void setKeywordsUppercase(boolean keywordsUppercase)

setKeywordsLowercase

public void setKeywordsLowercase(boolean keywordsLowercase)

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)

setPlscope

public void setPlscope(boolean plscope)

setSaveSourceCode

public void setSaveSourceCode(boolean saveSourceCode)

getApplicationName

public String getApplicationName()

getOutputDirectory

public File getOutputDirectory()

getInputFiles

public Collection getInputFiles()

getStylesheet

public String getStylesheet()

getStylesheetFile

public InputStream getStylesheetFile()
                              throws IOException

Throws:

IOException

getSourceStylesheet

public String getSourceStylesheet()

getSourceStylesheetFile

public InputStream getSourceStylesheetFile()
                                    throws IOException

Throws:

IOException

getOverviewFile

public File getOverviewFile()

getDefines

public Properties getDefines()

isIgnoreInformalComments

public boolean isIgnoreInformalComments()

isNamesDefaultcase

public boolean isNamesDefaultcase()

isKeywordsDefaultcase

public boolean isKeywordsDefaultcase()

isNamesUppercase

public boolean isNamesUppercase()

isNamesLowercase

public boolean isNamesLowercase()

getDefaultNamescase

public String getDefaultNamescase()

getDefaultKeywordscase

public String getDefaultKeywordscase()

isKeywordsUppercase

public boolean isKeywordsUppercase()

isKeywordsLowercase

public boolean isKeywordsLowercase()

getInputEncoding

public String getInputEncoding()

getOutputEncoding

public String getOutputEncoding()

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()

isPlscope

public boolean isPlscope()

isSaveSourceCode

public boolean isSaveSourceCode()