net.sf.statscm
Class StatConf

java.lang.Object
  net.sf.statcvs.output.ConfigurationOptions
      net.sf.statscm.StatConf

public class StatConf
extends net.sf.statcvs.output.ConfigurationOptions

Central StatSCM Configuration object.

Author:

DoCulnan

Field Summary

protected static java.lang.String	CONNECTION_TYPE_CVS String identifier for CVS connetion type
protected static java.lang.String	CONNECTION_TYPE_SVN String identifier for Subversion connetion type
protected java.lang.String	FILE_SEPARATOR Conveniance variable to deal with the Unix (/) DOS (\) problem.
protected static java.lang.String	STATSCM_DIR_NAME Name of directory for HTML and xdoc files.

Method Summary

void	configure(org.apache.maven.project.MavenProject project, java.util.Locale locale) To be called by plugin.
protected java.lang.String	extractConnectionType(java.lang.String connectionUrl) Try and extract the connection type for the url from the the Maven SCM Connection URL.
java.io.File	getBaseDirectory() Getter for the Base Directory.
protected java.lang.String	getConnectionType() Returns the type of SCM system.
java.util.Locale	getLocale()
java.lang.String	getSCMLogFileName() Method to access the Absolute location of the log file.
boolean	isStatCVS() Is the Maven Project using CVS as a SCM system?
boolean	isStatSVN() Is the Maven Project using SVN as a SCM system?
static void	setConfigFile(java.lang.String configFile)
void	setLocale(java.util.Locale locale)

Methods inherited from class net.sf.statcvs.output.ConfigurationOptions

addNonDeveloperLogin, getCharSet, getCheckedOutDirectory, getConfigBooleanProperty, getConfigColorProperty, getConfigColorProperty, getConfigFloatProperty, getConfigIntegerProperty, getConfigIntegerProperty, getConfigIntegerProperty, getConfigProperties, getConfigStringProperty, getConfigStringProperty, getCssHandler, getExcludePattern, getIncludePattern, getLogFileName, getLoggingProperties, getMarkupSyntax, getNonDeveloperLogins, getNotes, getOutputDir, getOutputFormat, getProjectName, getSymbolicNamesPattern, getWebBugtracker, getWebRepository, isEnableTwitterButton, setBugzillaUrl, setCharSet, setCheckedOutDirectory, setChoraURL, setCssFile, setCvswebURL, setDebugLogging, setDefaultCssFile, setEnableTwitterButton, setExcludePattern, setIncludePattern, setJCVSWebURL, setLogFileName, setMantisUrl, setNotesFile, setOutputDir, setOutputFormat, setProjectName, setSymbolicNamesPattern, setVerboseLogging, setViewCvsURL, setViewTracURL, setViewVcURL, setWebRepositoryIntegration

Methods inherited from class java.lang.Object

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

Field Detail

STATSCM_DIR_NAME

protected static final java.lang.String STATSCM_DIR_NAME

Name of directory for HTML and xdoc files.

See Also:

Constant Field Values

CONNECTION_TYPE_SVN

protected static final java.lang.String CONNECTION_TYPE_SVN

String identifier for Subversion connetion type

See Also:

Constant Field Values

CONNECTION_TYPE_CVS

protected static final java.lang.String CONNECTION_TYPE_CVS

String identifier for CVS connetion type

See Also:

Constant Field Values

FILE_SEPARATOR

protected java.lang.String FILE_SEPARATOR

Conveniance variable to deal with the Unix (/) DOS (\) problem. This is a shortcut for System.getProperty("file.separator").

Method Detail

setConfigFile

public static void setConfigFile(java.lang.String configFile)

configure

public void configure(org.apache.maven.project.MavenProject project,
                      java.util.Locale locale)
               throws net.sf.statcvs.output.ConfigurationException

To be called by plugin. If this is not called early in the process then nothing will work.

Parameters:

project - Maven Project Object Model (pom.xml).

Throws:

net.sf.statcvs.output.ConfigurationException - Throws error if there is any problem with the configuration.

getConnectionType

protected java.lang.String getConnectionType()

Returns the type of SCM system.

Returns:

String represeting an ID for type of connection.

isStatSVN

public boolean isStatSVN()

Is the Maven Project using SVN as a SCM system?

Returns:

true if SVN

isStatCVS

public boolean isStatCVS()

Is the Maven Project using CVS as a SCM system?

Returns:

true if CVS

extractConnectionType

protected java.lang.String extractConnectionType(java.lang.String connectionUrl)

Try and extract the connection type for the url from the the Maven SCM Connection URL.

Parameters:

connectionUrl - Maven SCM Connection URL.

Returns:

String represeting an ID for type of connection or null if can not be extracted.

getSCMLogFileName

public java.lang.String getSCMLogFileName()

Method to access the Absolute location of the log file.

Returns:

Absolute path of log file.

getBaseDirectory

public java.io.File getBaseDirectory()

Getter for the Base Directory.

Returns:

root folder for project.

getLocale

public java.util.Locale getLocale()

setLocale

public void setLocale(java.util.Locale locale)