software.amazon.awscdk

Class IgnoreStrategy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.IgnoreStrategy

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

Direct Known Subclasses:

DockerIgnoreStrategy, GitIgnoreStrategy, GlobIgnoreStrategy

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

(experimental) Represents file path ignoring behavior.

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	IgnoreStrategy()
protected	IgnoreStrategy(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	IgnoreStrategy(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
abstract void	add(String pattern) (experimental) Adds another pattern.
static DockerIgnoreStrategy	docker(String absoluteRootPath, List<String> patterns) (experimental) Ignores file paths based on the [`.dockerignore specification`](https://docs.docker.com/engine/reference/builder/#dockerignore-file).
static IgnoreStrategy	fromCopyOptions(CopyOptions options, String absoluteRootPath) (experimental) Creates an IgnoreStrategy based on the `ignoreMode` and `exclude` in a `CopyOptions`.
static GitIgnoreStrategy	git(String absoluteRootPath, List<String> patterns) (experimental) Ignores file paths based on the [`.gitignore specification`](https://git-scm.com/docs/gitignore).
static GlobIgnoreStrategy	glob(String absoluteRootPath, List<String> patterns) (experimental) Ignores file paths based on simple glob patterns.
abstract Boolean	ignores(String absoluteFilePath) (experimental) Determines whether a given file path should be ignored or not.

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

IgnoreStrategy

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

IgnoreStrategy

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

IgnoreStrategy

@Stability(value=Experimental)
protected IgnoreStrategy()

Method Detail

docker

@Stability(value=Experimental)
 @NotNull
public static DockerIgnoreStrategy docker(@NotNull
                                                                                   String absoluteRootPath,
                                                                                   @NotNull
                                                                                   List<String> patterns)

(experimental) Ignores file paths based on the [`.dockerignore specification`](https://docs.docker.com/engine/reference/builder/#dockerignore-file).

Parameters:

absoluteRootPath - the absolute path to the root directory of the paths to be considered. This parameter is required.

patterns - This parameter is required.

Returns:

`DockerIgnorePattern` associated with the given patterns.

fromCopyOptions

@Stability(value=Experimental)
 @NotNull
public static IgnoreStrategy fromCopyOptions(@NotNull
                                                                                      CopyOptions options,
                                                                                      @NotNull
                                                                                      String absoluteRootPath)

(experimental) Creates an IgnoreStrategy based on the `ignoreMode` and `exclude` in a `CopyOptions`.

Parameters:

options - the `CopyOptions` to create the `IgnoreStrategy` from. This parameter is required.

absoluteRootPath - the absolute path to the root directory of the paths to be considered. This parameter is required.

Returns:

`IgnoreStrategy` based on the `CopyOptions`

git

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

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

Parameters:

absoluteRootPath - the absolute path to the root directory of the paths to be considered. This parameter is required.

patterns - This parameter is required.

Returns:

`GitIgnorePattern` associated with the given patterns.

glob

@Stability(value=Experimental)
 @NotNull
public static GlobIgnoreStrategy glob(@NotNull
                                                                               String absoluteRootPath,
                                                                               @NotNull
                                                                               List<String> patterns)

(experimental) Ignores file paths based on simple glob patterns.

Parameters:

absoluteRootPath - the absolute path to the root directory of the paths to be considered. This parameter is required.

patterns - This parameter is required.

Returns:

`GlobIgnorePattern` associated with the given patterns.

add

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

(experimental) Adds another pattern.

Parameters:

pattern - This parameter is required.

ignores

@Stability(value=Experimental)
 @NotNull
public abstract Boolean ignores(@NotNull
                                                                         String absoluteFilePath)

(experimental) Determines whether a given file path should be ignored or not.

Parameters:

absoluteFilePath - absolute file path to be assessed against the pattern. This parameter is required.

Returns:

`true` if the file should be ignored