Package hudson.scm
Class CvsProjectset
java.lang.Object
hudson.scm.SCM
hudson.scm.AbstractCvs
hudson.scm.CvsProjectset
- All Implemented Interfaces:
ExtensionPoint
,Describable<SCM>
,ICvs
,Serializable
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from interface hudson.ExtensionPoint
ExtensionPoint.LegacyInstancesAreScopedToHudson
-
Field Summary
Fields inherited from class hudson.scm.AbstractCvs
DATE_FORMATTER
Fields inherited from class hudson.scm.SCM
PERMISSIONS, TAG
-
Constructor Summary
ConstructorDescriptionCvsProjectset
(CvsRepository[] repositories, boolean canUseUpdate, String username, String password, CVSRepositoryBrowser browser, boolean skipChangeLog, boolean pruneEmptyDirectories, boolean disableCvsQuiet, boolean cleanOnFailedUpdate, boolean forceCleanCopy) -
Method Summary
Modifier and TypeMethodDescriptionboolean
checkout
(AbstractBuild<?, ?> build, Launcher launcher, FilePath workspace, BuildListener listener, File changelogFile) void
checkout
(Run<?, ?> build, Launcher launcher, FilePath workspace, TaskListener listener, File changelogFile, SCMRevisionState baseline) protected PollingResult
compareRemoteRevisionWith
(AbstractProject<?, ?> project, Launcher launcher, FilePath workspace, TaskListener listener, SCMRevisionState baseline) Gets the descriptor for the current plugin.Gets a list of all repositories configured for this job.boolean
Whether CVS update can be used in place of CVS checkout if a workspace is already checked out.boolean
Allows cleaning of the workspace with a fresh checkout if CVS update fails.boolean
CVS is normally run in quiet mode to reduce un-needed log output.boolean
Whether to checkout an individual module's files directly into the workspace root rather than into a subdirectory of the module name.boolean
Controls whether CVS should apply the 'C' option to update commands to overwrite local changes.boolean
Whether CVS should be instructed to remove empty directories as part of checkout/update.boolean
Allows the option of skipping the changelog generation after checkout.boolean
Methods inherited from class hudson.scm.AbstractCvs
calcRevisionsFromBuild, calcRevisionsFromBuild, calculateChangeLog, calculateRepositoryState, checkout, compareRemoteRevisionWith, createChangeLogParser, getCheckoutDate, getCvsClient, getCvsClient, getGlobalOptions, isCheckoutCurrentTimestamp, isSymLink, postCheckout
Methods inherited from class hudson.scm.SCM
_calcRevisionsFromBuild, _for, _for, all, buildEnvironment, buildEnvVars, compareRemoteRevisionWith, createEmptyChangeLog, createEmptyChangeLog, getApi, getEffectiveBrowser, getKey, getModuleRoot, getModuleRoot, getModuleRoots, getModuleRoots, getType, guessBrowser, nullify, poll, pollChanges, postCheckout, postCheckout, processWorkspaceBeforeDeletion, processWorkspaceBeforeDeletion, supportsPolling
-
Constructor Details
-
CvsProjectset
@DataBoundConstructor public CvsProjectset(CvsRepository[] repositories, boolean canUseUpdate, String username, String password, CVSRepositoryBrowser browser, boolean skipChangeLog, boolean pruneEmptyDirectories, boolean disableCvsQuiet, boolean cleanOnFailedUpdate, boolean forceCleanCopy)
-
-
Method Details
-
getRepositories
Description copied from interface:ICvs
Gets a list of all repositories configured for this job. This list does not include any added through discovery e.g. parsing projectsets or ant scripts, purely those configured through the config page.- Returns:
- a list of configured repositories.
-
getUsername
-
getPassword
-
isCanUseUpdate
@Exported public boolean isCanUseUpdate()Description copied from interface:ICvs
Whether CVS update can be used in place of CVS checkout if a workspace is already checked out.- Returns:
- true is the
cvs up
can be used in place ofcvs co
under the correct circumstances.
-
compareRemoteRevisionWith
protected PollingResult compareRemoteRevisionWith(AbstractProject<?, ?> project, Launcher launcher, FilePath workspace, TaskListener listener, SCMRevisionState baseline) throws IOException, InterruptedException- Overrides:
compareRemoteRevisionWith
in classSCM
- Throws:
IOException
InterruptedException
-
checkout
public boolean checkout(AbstractBuild<?, ?> build, Launcher launcher, FilePath workspace, BuildListener listener, File changelogFile) throws IOException, InterruptedException- Overrides:
checkout
in classSCM
- Throws:
IOException
InterruptedException
-
checkout
public void checkout(@NonNull Run<?, ?> build, @NonNull Launcher launcher, @NonNull FilePath workspace, @NonNull TaskListener listener, @CheckForNull File changelogFile, @CheckForNull SCMRevisionState baseline) throws IOException, InterruptedException- Overrides:
checkout
in classSCM
- Throws:
IOException
InterruptedException
-
requiresWorkspaceForPolling
public boolean requiresWorkspaceForPolling()- Overrides:
requiresWorkspaceForPolling
in classSCM
-
isPruneEmptyDirectories
@Exported public boolean isPruneEmptyDirectories()Description copied from interface:ICvs
Whether CVS should be instructed to remove empty directories as part of checkout/update.- Returns:
- if CVS should remove empty directories from the workspace on checkout
-
isCleanOnFailedUpdate
@Exported public boolean isCleanOnFailedUpdate()Description copied from interface:ICvs
Allows cleaning of the workspace with a fresh checkout if CVS update fails.- Returns:
- whether to do a workspace wipe-out followed be CVS checkout if CVS update fails
-
isDisableCvsQuiet
@Exported public boolean isDisableCvsQuiet()Description copied from interface:ICvs
CVS is normally run in quiet mode to reduce un-needed log output. This option allows plugins to stop quiet mode being enabled.- Specified by:
isDisableCvsQuiet
in interfaceICvs
- Overrides:
isDisableCvsQuiet
in classAbstractCvs
- Returns:
- whether to disable quiet mode or not.
-
isSkipChangeLog
@Exported public boolean isSkipChangeLog()Description copied from interface:ICvs
Allows the option of skipping the changelog generation after checkout. Primarily used to save time as part of the build process . Has no effect on the polling configuration which uses a similar method to calculate changes.- Returns:
- whether changelog generation should be skipped or not.
-
isForceCleanCopy
@Exported public boolean isForceCleanCopy()Description copied from interface:ICvs
Controls whether CVS should apply the 'C' option to update commands to overwrite local changes.- Returns:
- whether CVS should over-write modifications to controlled files int he workspace during update
-
isFlatten
public boolean isFlatten()Description copied from interface:ICvs
Whether to checkout an individual module's files directly into the workspace root rather than into a subdirectory of the module name. Some scripts expect this functionality so this switch allows users to enabled or disable this. Some plugins may not have the option of supporting this if they automatically checkout multiple module (e.g. the CVS projectset plugin)- Returns:
- true if the files should be checkout directly into the workspace root, false if they should be put in a subdirectory.
-
getBrowser
- Overrides:
getBrowser
in classSCM
-
getDescriptor
Description copied from interface:ICvs
Gets the descriptor for the current plugin.- Specified by:
getDescriptor
in interfaceDescribable<SCM>
- Specified by:
getDescriptor
in interfaceICvs
- Overrides:
getDescriptor
in classAbstractCvs
- Returns:
- the current descriptor
- See Also:
-