software.amazon.awscdk

Class FileSystem

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.FileSystem

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.30.0 (build adae23f)",
           date="2021-06-30T10:00:43.721Z")
 @Stability(value=Experimental)
public class FileSystem
extends software.amazon.jsii.JsiiObject

(experimental) File system utilities.

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Constructor Summary

Constructors

Modifier	Constructor and Description
	FileSystem()
protected	FileSystem(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	FileSystem(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
static void	copyDirectory(String srcDir, String destDir) (experimental) Copies an entire directory structure.
static void	copyDirectory(String srcDir, String destDir, CopyOptions options) (experimental) Copies an entire directory structure.
static void	copyDirectory(String srcDir, String destDir, CopyOptions options, String rootDir) (experimental) Copies an entire directory structure.
static String	fingerprint(String fileOrDirectory) (experimental) Produces fingerprint based on the contents of a single file or an entire directory tree.
static String	fingerprint(String fileOrDirectory, FingerprintOptions options) (experimental) Produces fingerprint based on the contents of a single file or an entire directory tree.
static String	getTmpdir() (experimental) The real path of the system temp directory.
static Boolean	isEmpty(String dir) (experimental) Checks whether a directory is empty.
static String	mkdtemp(String prefix) (experimental) Creates a unique temporary directory in the **system temp directory**.

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

FileSystem

protected FileSystem(software.amazon.jsii.JsiiObjectRef objRef)

FileSystem

protected FileSystem(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

FileSystem

@Stability(value=Experimental)
public FileSystem()

Method Detail

copyDirectory

@Stability(value=Experimental)
public static void copyDirectory(@NotNull
                                                                String srcDir,
                                                                @NotNull
                                                                String destDir,
                                                                @Nullable
                                                                CopyOptions options,
                                                                @Nullable
                                                                String rootDir)

(experimental) Copies an entire directory structure.

Parameters:

srcDir - Source directory. This parameter is required.

destDir - Destination directory. This parameter is required.

options - options.

rootDir - Root directory to calculate exclusions from.

copyDirectory

@Stability(value=Experimental)
public static void copyDirectory(@NotNull
                                                                String srcDir,
                                                                @NotNull
                                                                String destDir,
                                                                @Nullable
                                                                CopyOptions options)

(experimental) Copies an entire directory structure.

Parameters:

srcDir - Source directory. This parameter is required.

destDir - Destination directory. This parameter is required.

options - options.

copyDirectory

@Stability(value=Experimental)
public static void copyDirectory(@NotNull
                                                                String srcDir,
                                                                @NotNull
                                                                String destDir)

(experimental) Copies an entire directory structure.

Parameters:

srcDir - Source directory. This parameter is required.

destDir - Destination directory. This parameter is required.

fingerprint

@Stability(value=Experimental)
 @NotNull
public static String fingerprint(@NotNull
                                                                          String fileOrDirectory,
                                                                          @Nullable
                                                                          FingerprintOptions options)

(experimental) Produces fingerprint based on the contents of a single file or an entire directory tree.

The fingerprint will also include:

1. An extra string if defined in options.extra.
2. The set of exclude patterns, if defined in options.exclude
3. The symlink follow mode value.

Parameters:

fileOrDirectory - The directory or file to fingerprint. This parameter is required.

options - Fingerprinting options.

fingerprint

@Stability(value=Experimental)
 @NotNull
public static String fingerprint(@NotNull
                                                                          String fileOrDirectory)

(experimental) Produces fingerprint based on the contents of a single file or an entire directory tree.

The fingerprint will also include:

1. An extra string if defined in options.extra.
2. The set of exclude patterns, if defined in options.exclude
3. The symlink follow mode value.

Parameters:

fileOrDirectory - The directory or file to fingerprint. This parameter is required.

isEmpty

@Stability(value=Experimental)
 @NotNull
public static Boolean isEmpty(@NotNull
                                                                       String dir)

(experimental) Checks whether a directory is empty.

Parameters:

dir - The directory to check. This parameter is required.

mkdtemp

@Stability(value=Experimental)
 @NotNull
public static String mkdtemp(@NotNull
                                                                      String prefix)

(experimental) Creates a unique temporary directory in the **system temp directory**.

Parameters:

prefix - A prefix for the directory name. This parameter is required.

getTmpdir

@Stability(value=Experimental)
 @NotNull
public static String getTmpdir()

(experimental) The real path of the system temp directory.