Package hudson.plugins.copyartifact

Class FilePathCopyMethod

java.lang.Object

hudson.plugins.copyartifact.Copier

hudson.plugins.copyartifact.FilePathCopyMethod

All Implemented Interfaces:

ExtensionPoint

@Deprecated
@Extension(ordinal=-200.0)
public class FilePathCopyMethod
extends Copier

Deprecated.

No longer used.

Default implementation of CopyMethod extension point, using the Jenkins FilePath class. Has -100 ordinal value so any other plugin implementing this extension point should override this one.

Author:

Alan Harder

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
FilePathCopyMethod()	Deprecated.

Method Summary

Modifier and Type	Method	Description
Copier	clone()	Deprecated. Creates a clone.
int	copyAll(FilePath srcDir, String filter, String excludes, FilePath targetDir, boolean fingerprintArtifacts)	Deprecated. Copy files matching the given file mask to the specified target.
void	copyOne(FilePath source, FilePath target, boolean fingerprintArtifacts)	Deprecated. Copy a single file.
void	initialize(Run<?,?> src, Run<?,?> dst, FilePath srcDir, FilePath baseTargetDir)	Deprecated. Called before copy-artifact operation.

Methods inherited from class hudson.plugins.copyartifact.Copier

copyAll, copyAll, copyOne, end, init

Methods inherited from class java.lang.Object

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

Constructor Detail

FilePathCopyMethod

public FilePathCopyMethod()

Deprecated.

Method Detail

copyAll

public int copyAll(FilePath srcDir,
                   String filter,
                   String excludes,
                   FilePath targetDir,
                   boolean fingerprintArtifacts)
            throws IOException,
                   InterruptedException

Deprecated.

Description copied from class: Copier

Copy files matching the given file mask to the specified target. You must override this when deriving Copier.

Overrides:

copyAll in class Copier

Parameters:

srcDir - Source directory

filter - Ant GLOB pattern

excludes - Ant GLOB pattern. Can be null.

targetDir - Target directory

fingerprintArtifacts - boolean controlling if the copy should also fingerprint the artifacts

Returns:

Number of files that were copied

Throws:

IOException - if an error occurs while performing the operation.

InterruptedException - if any thread interrupts the current thread.

See Also:

FilePath.copyRecursiveTo(String,FilePath)

copyOne

public void copyOne(FilePath source,
                    FilePath target,
                    boolean fingerprintArtifacts)
             throws IOException,
                    InterruptedException

Deprecated.

Description copied from class: Copier

Copy a single file.

Specified by:

copyOne in class Copier

Parameters:

source - Source file

target - Target file (includes filename; this is not the target directory). Directory for target should already exist (copy-artifact build step calls mkdirs).

fingerprintArtifacts - boolean controlling if the copy should also fingerprint the artifacts

Throws:

IOException - if an error occurs while performing the operation.

InterruptedException - if any thread interrupts the current thread.

See Also:

FilePath.copyTo(FilePath)

clone

public Copier clone()

Deprecated.

Description copied from class: Copier

Creates a clone. This method is only called before the Copier.init(Run, AbstractBuild, FilePath, FilePath) method to allow each initialize-end session to run against different objects, so you need not copy any state that your Copier might maintain. This is a cheap hack to implement a factory withot breaking backward compatibility. If you maintain no state, this method can return this without creating a copy.

Specified by:

clone in class Copier

initialize

public void initialize(Run<?,?> src,
                       Run<?,?> dst,
                       FilePath srcDir,
                       FilePath baseTargetDir)
                throws IOException,
                       InterruptedException

Deprecated.

Description copied from class: Copier

Called before copy-artifact operation.

Overrides:

initialize in class Copier

Parameters:

src - The build record from which we are copying artifacts.

dst - The built into which we are copying artifacts.

srcDir - Source for upcoming file copy

baseTargetDir - Base target dir for upcoming file copy (the copy-artifact build step may later specify a deeper target dir)

Throws:

IOException - if an error occurs while performing the operation.

InterruptedException - if any thread interrupts the current thread.