Package com.nike.pdm.localstack.core

Class LocalStackDir

  • public class LocalStackDir
extends java.lang.Object
    Utility class for locating and working with the LocalStack working directory.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String DATA_SUBDIRECTORY_NAME
      Name of the sub-directory of the localstack directory where localstack data is stored by the docker-compose plugin.
      static java.lang.String DEFAULT_LOCALSTACK_DIR_NAME
      Name of the Nike default localstack directory normally located at the root of a project.

    • Constructor Summary

      Constructors 
      Constructor Description
      LocalStackDir()  

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static void deleteData​(org.gradle.api.Project project)
      Deletes the ".localstack" data sub-directory of the localstack working directory.
      static boolean exists​(org.gradle.api.Project project)
      Checks to see if the "localstack" working directory exists in the project.
      static java.io.File getDirectory​(org.gradle.api.Project project)
      Gets the localstack working directory.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • DEFAULT_LOCALSTACK_DIR_NAME

        public static final java.lang.String DEFAULT_LOCALSTACK_DIR_NAME
        Name of the Nike default localstack directory normally located at the root of a project.
        See Also:
        Constant Field Values

      • DATA_SUBDIRECTORY_NAME

        public static final java.lang.String DATA_SUBDIRECTORY_NAME
        Name of the sub-directory of the localstack directory where localstack data is stored by the docker-compose plugin.
        See Also:
        Constant Field Values

    • Constructor Detail

      • LocalStackDir

        public LocalStackDir()

    • Method Detail

      • getDirectory

        public static final java.io.File getDirectory​(org.gradle.api.Project project)
        Gets the localstack working directory.
        Parameters:
        project - gradle project
        Returns:
        the localstack working directory

      • exists

        public static boolean exists​(org.gradle.api.Project project)
        Checks to see if the "localstack" working directory exists in the project.
        Parameters:
        project - gradle project
        Returns:
        true if the working directory exists; otherwise false

      • deleteData

        public static void deleteData​(org.gradle.api.Project project)
        Deletes the ".localstack" data sub-directory of the localstack working directory.
        Parameters:
        project - gradle project