io.cloudshiftdev.awscdk.DockerIgnoreStrategy.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of kotlin-cdk-wrapper Show documentation

Kotlin DSL for AWS CDK

The newest version!

@file:Suppress("RedundantVisibilityModifier","RedundantUnitReturnType","RemoveRedundantQualifierName","unused","UnusedImport","ClassName","REDUNDANT_PROJECTION","DEPRECATION")

package io.cloudshiftdev.awscdk

import kotlin.Boolean
import kotlin.String
import kotlin.collections.List

/**
 * Ignores file paths based on the [`.dockerignore
 * specification`](https://docs.docker.com/engine/reference/builder/#dockerignore-file).
 *
 * Example:
 *
 * ```
 * // The code below shows an example of how to instantiate this type.
 * // The values are placeholders you should change.
 * import io.cloudshiftdev.awscdk.*;
 * DockerIgnoreStrategy dockerIgnoreStrategy = new DockerIgnoreStrategy("absoluteRootPath",
 * List.of("patterns"));
 * ```
 */
public open class DockerIgnoreStrategy(
  cdkObject: software.amazon.awscdk.DockerIgnoreStrategy,
) : IgnoreStrategy(cdkObject) {
  public constructor(absoluteRootPath: String, patterns: List) :
      this(software.amazon.awscdk.DockerIgnoreStrategy(absoluteRootPath, patterns)
  )

  /**
   * Adds another pattern.
   *
   * @param pattern 
   */
  public override fun add(pattern: String) {
    unwrap(this).add(pattern)
  }

  /**
   * Determines whether a given file path should be ignored or not.
   *
   * @return `true` if the file should be ignored
   * @param absoluteFilePath absolute file path to be assessed against the pattern. 
   */
  public override fun ignores(absoluteFilePath: String): Boolean =
      unwrap(this).ignores(absoluteFilePath)

  public companion object {
    internal fun wrap(cdkObject: software.amazon.awscdk.DockerIgnoreStrategy): DockerIgnoreStrategy
        = DockerIgnoreStrategy(cdkObject)

    internal fun unwrap(wrapped: DockerIgnoreStrategy): software.amazon.awscdk.DockerIgnoreStrategy
        = wrapped.cdkObject as software.amazon.awscdk.DockerIgnoreStrategy
  }
}