de.smartics.maven.plugin.buildmetadata.common
Class ScmControl

java.lang.Object
  de.smartics.maven.plugin.buildmetadata.common.ScmControl

public final class ScmControl
     
     

      
      extends 
      
      Object
     
     

Information to control the gathering of SCM meta data.

Author:

Robert Reiner

Constructor Summary

ScmControl(boolean failOnLocalModifications, boolean ignoreDotFilesInBaseDir, boolean offline, boolean addScmInfo, boolean validateCheckout, boolean failOnMissingRevision)
Default constructor.

Method Summary

boolean	isAddScmInfo() Returns the value for addScmInfo.
boolean	isFailOnLocalModifications() Returns the value for failOnLocalModifications.
boolean	isFailOnMissingRevision() Returns the value for failOnMissingRevision.
boolean	isIgnoreDotFilesInBaseDir() Returns the flag to ignore files and directories starting with a dot for checking modified files.
boolean	isOffline() Returns the value for offline.
boolean	isValidateCheckout() Returns the value for validateCheckout.

Methods inherited from class java.lang.Object

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

Constructor Detail

ScmControl

public ScmControl(boolean failOnLocalModifications,
                  boolean ignoreDotFilesInBaseDir,
                  boolean offline,
                  boolean addScmInfo,
                  boolean validateCheckout,
                  boolean failOnMissingRevision)

Default constructor.

Parameters:

failOnLocalModifications - the value for failOnLocalModifications.

ignoreDotFilesInBaseDir - the flag to ignore files and directories starting with a dot for checking modified files.

offline - the value for offline.

addScmInfo - the value for addScmInfo.

validateCheckout - the value for validateCheckout.

failOnMissingRevision - the value for failOnMissingRevision.

Method Detail

isFailOnLocalModifications

public boolean isFailOnLocalModifications()

Returns the value for failOnLocalModifications.

Flag to fail if local modifications have been found. The value is true if the build should fail if there are modifications (any files not in-sync with the remote repository), false if the fact is only to be noted in the build properties.

Returns:

the value for failOnLocalModifications.

isIgnoreDotFilesInBaseDir

public boolean isIgnoreDotFilesInBaseDir()

Returns the flag to ignore files and directories starting with a dot for checking modified files. This implicates that any files or directories, starting with a dot, are ignored when the check on changed files is run. If the value is true, dot files are ignored, if it is set to false, dot files are respected.

Returns:

the flag to ignore files and directories starting with a dot for checking modified files.

isOffline

public boolean isOffline()

Returns the value for offline.

In offline mode the plugin will not generate revision information.

Returns:

the value for offline.

isAddScmInfo

public boolean isAddScmInfo()

Returns the value for addScmInfo.

Add SCM information if set to true, skip it, if set to false. If you are not interested in SCM information, set this to false.

Returns:

the value for addScmInfo.

isValidateCheckout

public boolean isValidateCheckout()

Returns the value for validateCheckout.

If it should be checked if the local files are up-to-date with the remote files in the SCM repository. If the value is true the result of the check, including the list of changed files, is added to the build meta data.

Returns:

the value for validateCheckout.

isFailOnMissingRevision

public boolean isFailOnMissingRevision()

Returns the value for failOnMissingRevision.

Fail if revision is requested to be retrieved, access to SCM is provided, system is online, nothing should prevent the build from fetching the information.

If set to true the build will fail, if revision cannot be fetched, false will continue so that the meta data do not contain the revision.

Returns:

the value for failOnMissingRevision.