software.amazon.awscdk.core

Class FileSystem

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.core.FileSystem

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:34.993Z")
public class FileSystem
extends software.amazon.jsii.JsiiObject

File system utilities.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.core.*;
 FileSystem fileSystem = new FileSystem();
 

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(java.lang.String srcDir, java.lang.String destDir) Copies an entire directory structure.
static void	copyDirectory(java.lang.String srcDir, java.lang.String destDir, CopyOptions options) Copies an entire directory structure.
static void	copyDirectory(java.lang.String srcDir, java.lang.String destDir, CopyOptions options, java.lang.String rootDir) Copies an entire directory structure.
static java.lang.String	fingerprint(java.lang.String fileOrDirectory) Produces fingerprint based on the contents of a single file or an entire directory tree.
static java.lang.String	fingerprint(java.lang.String fileOrDirectory, FingerprintOptions options) Produces fingerprint based on the contents of a single file or an entire directory tree.
static java.lang.String	getTmpdir() The real path of the system temp directory.
static java.lang.Boolean	isEmpty(java.lang.String dir) Checks whether a directory is empty.
static java.lang.String	mkdtemp(java.lang.String prefix) Creates a unique temporary directory in the **system temp directory**.

Methods inherited from class java.lang.Object

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

Constructor Detail

FileSystem

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

FileSystem

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

FileSystem

public FileSystem()

Method Detail

copyDirectory

public static void copyDirectory(java.lang.String srcDir,
                                 java.lang.String destDir,
                                 CopyOptions options,
                                 java.lang.String rootDir)

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

public static void copyDirectory(java.lang.String srcDir,
                                 java.lang.String destDir,
                                 CopyOptions options)

Copies an entire directory structure.

Parameters:

srcDir - Source directory. This parameter is required.

destDir - Destination directory. This parameter is required.

options - options.

copyDirectory

public static void copyDirectory(java.lang.String srcDir,
                                 java.lang.String destDir)

Copies an entire directory structure.

Parameters:

srcDir - Source directory. This parameter is required.

destDir - Destination directory. This parameter is required.

fingerprint

public static java.lang.String fingerprint(java.lang.String fileOrDirectory,
                                           FingerprintOptions options)

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

public static java.lang.String fingerprint(java.lang.String fileOrDirectory)

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

public static java.lang.Boolean isEmpty(java.lang.String dir)

Checks whether a directory is empty.

Parameters:

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

mkdtemp

public static java.lang.String mkdtemp(java.lang.String prefix)

Creates a unique temporary directory in the **system temp directory**.

Parameters:

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

getTmpdir

public static java.lang.String getTmpdir()

The real path of the system temp directory.