Class GitIgnoreStrategy

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.IgnoreStrategy
software.amazon.awscdk.GitIgnoreStrategy
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)", date="2024-05-02T15:58:20.244Z") @Stability(Stable) public class GitIgnoreStrategy extends IgnoreStrategy
Ignores file paths based on the .gitignore specification.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.*;
 GitIgnoreStrategy gitIgnoreStrategy = new GitIgnoreStrategy("absoluteRootPath", List.of("patterns"));
 
  • Nested Class Summary

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

    software.amazon.jsii.JsiiObject.InitializationMode
  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
     
    GitIgnoreStrategy(String absoluteRootPath, List<String> patterns)
     
    protected
    GitIgnoreStrategy(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
     
    protected
    GitIgnoreStrategy(software.amazon.jsii.JsiiObjectRef objRef)
     
  • Method Summary

    Modifier and Type
    Method
    Description
    void
    add(String pattern)
    Adds another pattern.
    ignores(String absoluteFilePath)
    Determines whether a given file path should be ignored or not.

    Methods inherited from class software.amazon.awscdk.IgnoreStrategy

    docker, fromCopyOptions, git, glob

    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

    • GitIgnoreStrategy

      protected GitIgnoreStrategy(software.amazon.jsii.JsiiObjectRef objRef)
    • GitIgnoreStrategy

      protected GitIgnoreStrategy(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
    • GitIgnoreStrategy

      @Stability(Stable) public GitIgnoreStrategy(@NotNull String absoluteRootPath, @NotNull List<String> patterns)
      Parameters:
      absoluteRootPath - This parameter is required.
      patterns - This parameter is required.
  • Method Details

    • add

      @Stability(Stable) public void add(@NotNull String pattern)
      Adds another pattern.

      Specified by:
      add in class IgnoreStrategy
      Parameters:
      pattern - This parameter is required.
    • ignores

      @Stability(Stable) @NotNull public Boolean ignores(@NotNull String absoluteFilePath)
      Determines whether a given file path should be ignored or not.

      Specified by:
      ignores in class IgnoreStrategy
      Parameters:
      absoluteFilePath - absolute file path to be assessed against the pattern. This parameter is required.
      Returns:
      true if the file should be ignored