CopyStep (Buck)

java.lang.Object
- com.facebook.buck.step.fs.CopyStep

All Implemented Interfaces:: Step

public class CopyStep
extends Object
implements Step

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`CopyStep.DirectoryMode` When copying a directory, this specifies whether only the contents of the directory should be copied, or if the directory itself should be included.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`StepExecutionResult`	`execute(ExecutionContext context)`
`static CopyStep`	`forDirectory(ProjectFilesystem filesystem, Path source, Path destination, CopyStep.DirectoryMode directoryMode)` Creates a CopyStep which recursively copies a directory from 'source' to 'destination'.
`static CopyStep`	`forFile(ProjectFilesystem filesystem, Path source, Path destination)` Creates a CopyStep which copies a single file from 'source' to 'destination'.
`String`	`getDescription(ExecutionContext context)`
`String`	`getShortName()`
`boolean`	`isRecursive()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

forFile

public static CopyStep forFile(ProjectFilesystem filesystem,
                               Path source,
                               Path destination)

Creates a CopyStep which copies a single file from 'source' to 'destination'.

forDirectory

public static CopyStep forDirectory(ProjectFilesystem filesystem,
                                    Path source,
                                    Path destination,
                                    CopyStep.DirectoryMode directoryMode)

Creates a CopyStep which recursively copies a directory from 'source' to 'destination'. See CopyStep.DirectoryMode for options to control the copy.

getShortName
```
public String getShortName()
```
Specified by:

getShortName in interface Step

Returns:

a short name/description for the command, such as "javac". Should fit on one line.

getDescription

public String getDescription(ExecutionContext context)

Specified by:: getDescription in interface Step

isRecursive
```
public boolean isRecursive()
```

execute

public StepExecutionResult execute(ExecutionContext context)
                            throws IOException

Specified by:: execute in interface Step
Throws:: IOException

Class CopyStep