|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectnet.sf.statcvs.output.ConfigurationOptions
public class ConfigurationOptions
Class for storing all command line parameters. The parameters
are set by the Main.main(java.lang.String[])
method. Interested classes
can read all parameter values from here.
Constructor Summary | |
---|---|
ConfigurationOptions()
|
Method Summary | |
---|---|
static java.lang.String |
getCheckedOutDirectory()
Method getCheckedOutDirectory. |
static CssHandler |
getCssHandler()
returns the CssHandler |
static java.lang.String |
getLogFileName()
Method getLogfilename. |
static java.lang.String |
getLoggingProperties()
Gets the name of the logging properties file |
static java.lang.String |
getNotes()
Returns the report notes (from "-notes filename" switch) or null if not specified |
static java.lang.String |
getOutputDir()
Returns the outputDir. |
static java.lang.String |
getProjectName()
Method getProjectName. |
static boolean |
getShowCreditInformation()
Returns whether the credit information should be shown |
static WebRepositoryIntegration |
getWebRepository()
Returns a WebRepositoryIntegration object if the user
has specified a URL to one. |
static boolean |
matchesPatterns(java.lang.String filename)
Matches a filename against the include and exclude patterns. |
static void |
setCheckedOutDirectory(java.lang.String checkedOutDirectory)
Sets the checkedOutDirectory. |
static void |
setChoraURL(java.lang.String url)
Sets the URL to a Chora web-based CVS browser. |
static void |
setCssFile(java.lang.String cssFile)
Sets the cssFile. |
static void |
setCvswebURL(java.lang.String url)
Sets the URL to a cvsweb web-based CVS browser. |
static void |
setDebugLogging()
Sets the logging level to debug |
static void |
setExcludePattern(java.lang.String patternList)
Sets a file exclude pattern list. |
static void |
setIncludePattern(java.lang.String patternList)
Sets a file include pattern list. |
static void |
setLogFileName(java.lang.String logFileName)
Sets the logFileName. |
static void |
setNotesFile(java.lang.String notesFile)
Sets the name of the notes file. |
static void |
setOutputDir(java.lang.String outputDir)
Sets the outputDir. |
static void |
setProjectTitle(java.lang.String projectTitle)
Sets a project title to be used in the reports |
static void |
setShowCreditInformation(boolean enable)
Enabe or disable the credit information in the generated charts |
static void |
setVerboseLogging()
Sets the logging level to verbose |
static void |
setViewCvsURL(java.lang.String url)
Sets the URL to a ViewCVS web-based CVS browser. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ConfigurationOptions()
Method Detail |
---|
public static CssHandler getCssHandler()
CssHandler
public static java.lang.String getProjectName()
public static java.lang.String getCheckedOutDirectory()
public static java.lang.String getLogFileName()
public static java.lang.String getOutputDir()
public static java.lang.String getNotes()
public static boolean getShowCreditInformation()
public static WebRepositoryIntegration getWebRepository()
WebRepositoryIntegration
object if the user
has specified a URL to one. null otherwise.
public static void setCheckedOutDirectory(java.lang.String checkedOutDirectory) throws ConfigurationException
checkedOutDirectory
- The checkedOutDirectory to set
ConfigurationException
- if directory does not existpublic static void setCssFile(java.lang.String cssFile) throws ConfigurationException
cssFile
- The cssFile to set
ConfigurationException
- if the specified CSS file can not be
accessed from local file system or from URL source, or if the specified
CSS file is local and does not existpublic static void setLogFileName(java.lang.String logFileName) throws ConfigurationException
logFileName
- The logFileName to set
ConfigurationException
- if the file does not existpublic static void setOutputDir(java.lang.String outputDir) throws ConfigurationException
outputDir
- The outputDir to set
ConfigurationException
- if the output directory cannot be createdpublic static void setNotesFile(java.lang.String notesFile) throws ConfigurationException
IndexPage
of the output. It must contain a valid
block-level HTML fragment (for example
"<p>Some notes</p>")
notesFile
- a local filename
ConfigurationException
- if the file is not found or can't be readpublic static void setViewCvsURL(java.lang.String url)
url
- URL to a ViewCVS repositorypublic static void setCvswebURL(java.lang.String url)
url
- URL to a cvsweb repositorypublic static void setChoraURL(java.lang.String url)
url
- URL to a cvsweb repositorypublic static void setProjectTitle(java.lang.String projectTitle)
projectTitle
- The project title to be used in the reportspublic static java.lang.String getLoggingProperties()
public static void setVerboseLogging()
public static void setDebugLogging()
public static void setShowCreditInformation(boolean enable)
enable
- Enabe or disable the credit information in the generated chartspublic static void setIncludePattern(java.lang.String patternList)
patternList
- a list of Ant-style wildcard patterns, seperated
by : or ;FilePatternMatcher
public static void setExcludePattern(java.lang.String patternList)
patternList
- a list of Ant-style wildcard patterns, seperated
by : or ;FilePatternMatcher
public static boolean matchesPatterns(java.lang.String filename)
filename
- a filename
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |