Package 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.98.0 (build 00b106d)", date="2024-05-08T21:35:01.592Z") @Stability(Stable) 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.*;
 FileSystem fileSystem = new FileSystem();

  • Nested Class Summary

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

    software.amazon.jsii.JsiiObject.InitializationMode

  • Constructor Summary

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

  • Method Summary

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

    • FileSystem

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

    • FileSystem

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

    • FileSystem

      @Stability(Stable) public FileSystem()

  • Method Details

    • copyDirectory

      @Stability(Stable) public static void copyDirectory(@NotNull String srcDir, @NotNull String destDir, @Nullable CopyOptions options, @Nullable 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

      @Stability(Stable) public static void copyDirectory(@NotNull String srcDir, @NotNull String destDir, @Nullable 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

      @Stability(Stable) public static void copyDirectory(@NotNull String srcDir, @NotNull String destDir)
      Copies an entire directory structure.

      Parameters:
      srcDir - Source directory. This parameter is required.
      destDir - Destination directory. This parameter is required.

    • fingerprint

      @Stability(Stable) @NotNull public static String fingerprint(@NotNull String fileOrDirectory, @Nullable FingerprintOptions options)
      Produces fingerprint based on the contents of a single file or an entire directory tree.

      Line endings are converted from CRLF to LF.

      The fingerprint will also include:

      1. An extra string if defined in options.extra.
      2. The symlink follow mode value.

      Parameters:
      fileOrDirectory - The directory or file to fingerprint. This parameter is required.
      options - Fingerprinting options.

    • fingerprint

      @Stability(Stable) @NotNull public static String fingerprint(@NotNull String fileOrDirectory)
      Produces fingerprint based on the contents of a single file or an entire directory tree.

      Line endings are converted from CRLF to LF.

      The fingerprint will also include:

      1. An extra string if defined in options.extra.
      2. The symlink follow mode value.

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

    • isEmpty

      @Stability(Stable) @NotNull public static Boolean isEmpty(@NotNull String dir)
      Checks whether a directory is empty.

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

    • mkdtemp

      @Stability(Stable) @NotNull public static String mkdtemp(@NotNull 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

      @Stability(Stable) @NotNull public static String getTmpdir()
      The real path of the system temp directory.