software.amazon.awscdk

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.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:35.900Z")
 @Stability(value=Stable)
public class GitIgnoreStrategy
extends IgnoreStrategy

Ignores file paths based on the [`.gitignore specification`](https://git-scm.com/docs/gitignore).

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 and Description
protected	GitIgnoreStrategy(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	GitIgnoreStrategy(software.amazon.jsii.JsiiObjectRef objRef)
	GitIgnoreStrategy(String absoluteRootPath, List<String> patterns)

Method Summary

Modifier and Type	Method and Description
void	add(String pattern) Adds another pattern.
Boolean	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 Detail

GitIgnoreStrategy

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

GitIgnoreStrategy

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

GitIgnoreStrategy

@Stability(value=Stable)
public GitIgnoreStrategy(@NotNull
                                                  String absoluteRootPath,
                                                  @NotNull
                                                  List<String> patterns)

Parameters:

absoluteRootPath - This parameter is required.

patterns - This parameter is required.

Method Detail

add

@Stability(value=Stable)
public void add(@NotNull
                                         String pattern)

Adds another pattern.

Specified by:

add in class IgnoreStrategy

Parameters:

pattern - This parameter is required.

ignores

@Stability(value=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