io.cloudshiftdev.awscdk.TimeConversionOptions.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 io.cloudshiftdev.awscdk.common.CdkDslMarker
import io.cloudshiftdev.awscdk.common.CdkObject
import io.cloudshiftdev.awscdk.common.CdkObjectWrappers
import kotlin.Boolean
import kotlin.Unit

/**
 * Options for how to convert time to a different unit.
 *
 * Example:
 *
 * ```
 * // The code below shows an example of how to instantiate this type.
 * // The values are placeholders you should change.
 * import io.cloudshiftdev.awscdk.*;
 * TimeConversionOptions timeConversionOptions = TimeConversionOptions.builder()
 * .integral(false)
 * .build();
 * ```
 */
public interface TimeConversionOptions {
  /**
   * If `true`, conversions into a larger time unit (e.g. `Seconds` to `Minutes`) will fail if the
   * result is not an integer.
   *
   * Default: true
   */
  public fun integral(): Boolean? = unwrap(this).getIntegral()

  /**
   * A builder for [TimeConversionOptions]
   */
  @CdkDslMarker
  public interface Builder {
    /**
     * @param integral If `true`, conversions into a larger time unit (e.g. `Seconds` to `Minutes`)
     * will fail if the result is not an integer.
     */
    public fun integral(integral: Boolean)
  }

  private class BuilderImpl : Builder {
    private val cdkBuilder: software.amazon.awscdk.TimeConversionOptions.Builder =
        software.amazon.awscdk.TimeConversionOptions.builder()

    /**
     * @param integral If `true`, conversions into a larger time unit (e.g. `Seconds` to `Minutes`)
     * will fail if the result is not an integer.
     */
    override fun integral(integral: Boolean) {
      cdkBuilder.integral(integral)
    }

    public fun build(): software.amazon.awscdk.TimeConversionOptions = cdkBuilder.build()
  }

  private class Wrapper(
    cdkObject: software.amazon.awscdk.TimeConversionOptions,
  ) : CdkObject(cdkObject),
      TimeConversionOptions {
    /**
     * If `true`, conversions into a larger time unit (e.g. `Seconds` to `Minutes`) will fail if the
     * result is not an integer.
     *
     * Default: true
     */
    override fun integral(): Boolean? = unwrap(this).getIntegral()
  }

  public companion object {
    public operator fun invoke(block: Builder.() -> Unit = {}): TimeConversionOptions {
      val builderImpl = BuilderImpl()
      return Wrapper(builderImpl.apply(block).build())
    }

    internal fun wrap(cdkObject: software.amazon.awscdk.TimeConversionOptions):
        TimeConversionOptions = CdkObjectWrappers.wrap(cdkObject) as? TimeConversionOptions ?:
        Wrapper(cdkObject)

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