public final class Configuration
extends java.lang.Object
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
EFTAR_DTAGS_FILE
The name of the eftar file relative to the DATA_ROOT, which
contains definition tags.
|
static java.lang.String |
FOOTER_INCLUDE_FILE
The name of the file relative to the DATA_ROOT, which should
be included into the footer of generated web pages.
|
static java.lang.String |
HEADER_INCLUDE_FILE
The name of the file relative to the DATA_ROOT, which should
be included into the footer of generated web pages.
|
Constructor and Description |
---|
Configuration()
Creates a new instance of Configuration
|
Modifier and Type | Method and Description |
---|---|
java.util.Set<java.lang.String> |
getAllowedSymlinks() |
java.lang.String |
getBugPage() |
java.lang.String |
getBugPattern() |
int |
getCachePages() |
java.util.Map<java.lang.String,java.lang.String> |
getCmds() |
java.lang.String |
getCtags() |
java.lang.String |
getDatabaseDriver() |
java.lang.String |
getDatabaseUrl() |
java.lang.String |
getDataRoot() |
java.util.Date |
getDateForLastIndexRun()
Get the date of the last index update.
|
Project |
getDefaultProject() |
java.io.File |
getDtagsEftar()
Get the eftar file, which contains definition tags.
|
java.lang.String |
getFooterIncludeFileContent()
Get the contents of the footer include file.
|
java.lang.String |
getHeaderIncludeFileContent()
Get the contents of the footer include file.
|
int |
getHistoryCacheTime()
How long can a history request take before it's cached? If the time
is exceeded, the result is cached.
|
int |
getHitsPerPage() |
IgnoredNames |
getIgnoredNames() |
Filter |
getIncludedNames() |
int |
getIndexWordLimit() |
java.util.List<Project> |
getProjects() |
java.lang.String |
getRepoCmd(java.lang.String clazzName) |
java.util.List<RepositoryInfo> |
getRepositories() |
java.lang.String |
getReviewPage() |
java.lang.String |
getReviewPattern() |
int |
getScanningDepth() |
java.lang.String |
getSourceRoot() |
int |
getTabSize()
Get the default tab size (number of space characters per tab character)
to use for each project.
|
java.lang.String |
getUrlPrefix() |
java.lang.String |
getUserPage() |
java.lang.String |
getUserPageSuffix() |
java.lang.String |
getWebappLAF() |
java.lang.String |
getXMLRepresentationAsString() |
boolean |
isAllowLeadingWildcard() |
boolean |
isChattyStatusPage() |
boolean |
isCompressXref() |
boolean |
isGenerateHtml() |
boolean |
isHistoryCache()
Should the history log be cached?
|
boolean |
isHistoryCacheInDB()
Should the history cache be stored in a database? If yes,
JDBCHistoryCache will be used to cache the history; otherwise,
FileHistoryCache is used. |
boolean |
isIndexVersionedFilesOnly() |
boolean |
isObfuscatingEMailAddresses() |
boolean |
isOptimizeDatabase() |
boolean |
isPrintProgress() |
boolean |
isQuickContextScan() |
boolean |
isRemoteScmSupported() |
boolean |
isUsingLuceneLocking() |
boolean |
isVerbose() |
static Configuration |
makeXMLStringAsConfiguration(java.lang.String xmlconfig) |
static Configuration |
read(java.io.File file) |
void |
setAllowedSymlinks(java.util.Set<java.lang.String> allowedSymlinks) |
void |
setAllowLeadingWildcard(boolean allowLeadingWildcard) |
void |
setBugPage(java.lang.String bugPage) |
void |
setBugPattern(java.lang.String bugPattern) |
void |
setCachePages(int cachePages) |
void |
setChattyStatusPage(boolean chattyStatusPage) |
void |
setCmds(java.util.Map<java.lang.String,java.lang.String> cmds) |
void |
setCompressXref(boolean compressXref) |
void |
setCtags(java.lang.String ctags) |
void |
setDatabaseDriver(java.lang.String databaseDriver) |
void |
setDatabaseUrl(java.lang.String databaseUrl) |
void |
setDataRoot(java.lang.String dataRoot) |
void |
setDefaultProject(Project defaultProject) |
void |
setGenerateHtml(boolean generateHtml) |
void |
setHistoryCache(boolean historyCache)
Set whether history should be cached.
|
void |
setHistoryCacheInDB(boolean historyCacheInDB)
Set whether the history cache should be stored in a database, and
JDBCHistoryCache should be used instead of FileHistoryCache . |
void |
setHistoryCacheTime(int historyCacheTime)
Set the maximum time a history request can take before it's cached.
|
void |
setHitsPerPage(int hitsPerPage) |
void |
setIgnoredNames(IgnoredNames ignoredNames) |
void |
setIncludedNames(Filter includedNames) |
void |
setIndexVersionedFilesOnly(boolean indexVersionedFilesOnly) |
void |
setIndexWordLimit(int indexWordLimit) |
void |
setObfuscatingEMailAddresses(boolean obfuscate) |
void |
setOptimizeDatabase(boolean optimizeDatabase) |
void |
setPrintProgress(boolean printProgress) |
void |
setProjects(java.util.List<Project> projects) |
void |
setQuickContextScan(boolean quickContextScan) |
void |
setRemoteScmSupported(boolean remoteScmSupported) |
java.lang.String |
setRepoCmd(java.lang.String clazzName,
java.lang.String cmd) |
void |
setRepositories(java.util.List<RepositoryInfo> repositories) |
void |
setReviewPage(java.lang.String reviewPage) |
void |
setReviewPattern(java.lang.String reviewPattern) |
void |
setScanningDepth(int scanningDepth) |
void |
setSourceRoot(java.lang.String sourceRoot) |
void |
setTabSize(int tabSize)
Set the default tab size (number of space characters per tab character)
to use for each project.
|
void |
setUrlPrefix(java.lang.String urlPrefix)
Set the URL prefix to be used by the
JavaClassAnalyzer as well
as lexers (see JFlexXref )
when they create output with html links. |
void |
setUserPage(java.lang.String userPage) |
void |
setUserPageSuffix(java.lang.String userPageSuffix) |
void |
setUsingLuceneLocking(boolean useLuceneLocking) |
void |
setVerbose(boolean verbose) |
void |
setWebappLAF(java.lang.String webappLAF) |
void |
write(java.io.File file)
Write the current configuration to a file
|
public static final java.lang.String FOOTER_INCLUDE_FILE
public static final java.lang.String HEADER_INCLUDE_FILE
public static final java.lang.String EFTAR_DTAGS_FILE
public int getTabSize()
<= 0
tabs are read/write as is.Project.getTabSize()
,
ExpandTabsReader
public void setTabSize(int tabSize)
<= 0
tabs are read/write as is.tabSize
- tabsize to set.Project.setTabSize(int)
,
ExpandTabsReader
public int getScanningDepth()
public void setScanningDepth(int scanningDepth)
public java.lang.String getRepoCmd(java.lang.String clazzName)
public java.lang.String setRepoCmd(java.lang.String clazzName, java.lang.String cmd)
public java.util.Map<java.lang.String,java.lang.String> getCmds()
public void setCmds(java.util.Map<java.lang.String,java.lang.String> cmds)
public java.lang.String getCtags()
public void setCtags(java.lang.String ctags)
public int getCachePages()
public void setCachePages(int cachePages)
public int getHitsPerPage()
public void setHitsPerPage(int hitsPerPage)
public boolean isHistoryCache()
true
if a HistoryCache
implementation should
be used, false
otherwisepublic void setHistoryCache(boolean historyCache)
historyCache
- if true
enable history cachepublic int getHistoryCacheTime()
FileHistoryCache
.public void setHistoryCacheTime(int historyCacheTime)
FileHistoryCache
is used.historyCacheTime
- maximum time in millisecondspublic boolean isHistoryCacheInDB()
JDBCHistoryCache
will be used to cache the history; otherwise,
FileHistoryCache
is used.public void setHistoryCacheInDB(boolean historyCacheInDB)
JDBCHistoryCache
should be used instead of FileHistoryCache
.historyCacheInDB
- whether the history cached should be stored in
a databasepublic java.util.List<Project> getProjects()
public void setProjects(java.util.List<Project> projects)
public java.lang.String getSourceRoot()
public void setSourceRoot(java.lang.String sourceRoot)
public java.lang.String getDataRoot()
public void setDataRoot(java.lang.String dataRoot)
public java.util.List<RepositoryInfo> getRepositories()
public void setRepositories(java.util.List<RepositoryInfo> repositories)
public java.lang.String getUrlPrefix()
public void setUrlPrefix(java.lang.String urlPrefix)
JavaClassAnalyzer
as well
as lexers (see JFlexXref
)
when they create output with html links.urlPrefix
- prefix to use.public void setGenerateHtml(boolean generateHtml)
public boolean isGenerateHtml()
public void setDefaultProject(Project defaultProject)
public Project getDefaultProject()
public int getIndexWordLimit()
public void setIndexWordLimit(int indexWordLimit)
public boolean isVerbose()
public void setVerbose(boolean verbose)
public boolean isPrintProgress()
public void setPrintProgress(boolean printProgress)
public void setAllowLeadingWildcard(boolean allowLeadingWildcard)
public boolean isAllowLeadingWildcard()
public boolean isQuickContextScan()
public void setQuickContextScan(boolean quickContextScan)
public void setIgnoredNames(IgnoredNames ignoredNames)
public IgnoredNames getIgnoredNames()
public void setIncludedNames(Filter includedNames)
public Filter getIncludedNames()
public void setUserPage(java.lang.String userPage)
public java.lang.String getUserPage()
public void setUserPageSuffix(java.lang.String userPageSuffix)
public java.lang.String getUserPageSuffix()
public void setBugPage(java.lang.String bugPage)
public java.lang.String getBugPage()
public void setBugPattern(java.lang.String bugPattern)
public java.lang.String getBugPattern()
public java.lang.String getReviewPage()
public void setReviewPage(java.lang.String reviewPage)
public java.lang.String getReviewPattern()
public void setReviewPattern(java.lang.String reviewPattern)
public java.lang.String getWebappLAF()
public void setWebappLAF(java.lang.String webappLAF)
public boolean isRemoteScmSupported()
public void setRemoteScmSupported(boolean remoteScmSupported)
public boolean isOptimizeDatabase()
public void setOptimizeDatabase(boolean optimizeDatabase)
public boolean isUsingLuceneLocking()
public void setUsingLuceneLocking(boolean useLuceneLocking)
public void setCompressXref(boolean compressXref)
public boolean isCompressXref()
public boolean isIndexVersionedFilesOnly()
public void setIndexVersionedFilesOnly(boolean indexVersionedFilesOnly)
public java.util.Date getDateForLastIndexRun()
public java.lang.String getFooterIncludeFileContent()
public java.lang.String getHeaderIncludeFileContent()
public java.io.File getDtagsEftar()
null
if there is no such file, the file otherwise.public java.lang.String getDatabaseDriver()
public void setDatabaseDriver(java.lang.String databaseDriver)
public java.lang.String getDatabaseUrl()
public void setDatabaseUrl(java.lang.String databaseUrl)
public java.util.Set<java.lang.String> getAllowedSymlinks()
public void setAllowedSymlinks(java.util.Set<java.lang.String> allowedSymlinks)
public boolean isObfuscatingEMailAddresses()
public void setObfuscatingEMailAddresses(boolean obfuscate)
public boolean isChattyStatusPage()
public void setChattyStatusPage(boolean chattyStatusPage)
public void write(java.io.File file) throws java.io.IOException
file
- the file to write the configuration intojava.io.IOException
- if an error occurspublic java.lang.String getXMLRepresentationAsString()
public static Configuration read(java.io.File file) throws java.io.IOException
java.io.IOException
public static Configuration makeXMLStringAsConfiguration(java.lang.String xmlconfig) throws java.io.IOException
java.io.IOException