Class FileHandling

java.lang.Object
org.ek9lang.core.FileHandling
public final class FileHandling extends Object
Designed to abstract out all file handling for the compiler.

  • Field Details

    • LIBRARY_DIRECTORY_PROPERTY

      public static final String LIBRARY_DIRECTORY_PROPERTY
      System property naming the library folder, instead of ~/.ek9/lib: tests point it at a fixture library holding a stub of each package they declare.
      See Also:

    • RUNTIME_JAR_PREFIX

      public static final String RUNTIME_JAR_PREFIX
      THE file-name prefix of every cached runtime jar in <projectDir>/.ek9/runtime/; the extractor removes any entry under it that is not the current one.
      See Also:

  • Constructor Details

    • FileHandling

      public FileHandling(OsSupport osSupport)
      Create File Handling with the appropriately configured OS support. Quite a few of these methods just delegate to OsSupport and the Packager.

  • Method Details

    • getTempDirectory

      public String getTempDirectory()

    • getUsersHomeDirectory

      public String getUsersHomeDirectory()

    • getUsersHomeEk9LibDirectory

      public File getUsersHomeEk9LibDirectory()
      THE library folder dependencies are installed into and resolved from: the folder named by the system property "ek9.library.directory" when set (never in a stub-mode sandbox, which keeps its own home), else ~/.ek9/lib. Every reader and writer of the library goes through here - the property is read nowhere else.

    • dependencyInstallation

      public DependencyInstallation dependencyInstallation()
      The library folder as a DependencyInstallation: where a dependency is unpacked or zipped.

    • getUsersHomeEk9Directory

      public String getUsersHomeEk9Directory()

    • getDotEk9Directory

      public String getDotEk9Directory(File directory)

    • getDotEk9Directory

      public String getDotEk9Directory(String fromDirectory)

    • makePackagedModuleZipFileName

      public String makePackagedModuleZipFileName(String moduleName, String version)

    • makePackagedModuleZipFileName

      public String makePackagedModuleZipFileName(String dependencyVector)

    • makeDependencyVector

      public String makeDependencyVector(String moduleName, String version)
      Create a full dependency vector out of module name and version.

    • copy

      public boolean copy(File sourceDir, File destinationDir, String fileName)
      Copy a named file from a source directory to a destination directory.

    • copy

      public boolean copy(File fullSourcePath, File fullDestinationPath)
      Copy a file to a new destination.

    • saveToOutput

      public boolean saveToOutput(File file, String value)
      Save some text to a file.

    • deleteFileIfExists

      public void deleteFileIfExists(File file)
      Deletes a file if it exists.

    • makeDirectoryIfNotExists

      public void makeDirectoryIfNotExists(File directory)
      Create a directory.

    • createOrRecreateFile

      public void createOrRecreateFile(File file)

    • deleteMatchingFiles

      public void deleteMatchingFiles(File dir, String fileNamePattern)
      deletes matching files.
      Parameters:
      dir - the directory to look in
      fileNamePattern - The pattern regex not shell so for * use .* for .txt use \\.txt

    • deleteContentsAndBelow

      public void deleteContentsAndBelow(File dir, boolean includeDirectoryRoot)
      Does a recursive delete from this directory and below. If includeDirectoryRoot is true then it will delete that directory as well

    • createSha256Of

      public Digest.CheckSum createSha256Of(String fileName)
      Create a sha256 hash of a file and save it in fileName".sha256"

    • createJar

      public boolean createJar(String fileName, List<ZipSet> sets)
      Create a Java jar file with a list of zip sets.

    • createJar

      public boolean createJar(String fileName, List<ZipSet> sets, String mainClass)
      Create a Java jar file with a list of zip sets and optional Main-Class manifest.
      Parameters:
      fileName - The name of the JAR file to create
      sets - The list of ZipSets to include
      mainClass - The fully-qualified main class name for manifest (null for no Main-Class)
      Returns:
      true if JAR creation successful

    • unZipFileTo

      public boolean unZipFileTo(File zipFile, String unpackedDir)

    • unZipFileTo

      public boolean unZipFileTo(File zipFile, File unpackedDir)
      Unzips a zip file into a directory, the directory will be created if it does not exist.

    • createZip

      public boolean createZip(String fileName, ZipSet set, File sourcePropertiesFile)
      To be used for making the zip when publishing ek9 source to artefact server.
      Parameters:
      fileName - The name of the zip to create
      sourcePropertiesFile - The properties file that describes the package.
      Returns:
      true if all OK.

    • getTargetExecutableArtefact

      public File getTargetExecutableArtefact(String ek9FullPathToFileName, TargetArchitecture targetArchitecture)

    • getTargetPropertiesArtefact

      public File getTargetPropertiesArtefact(String ek9FullPathToFileName)

    • getRuntimeDirectory

      public File getRuntimeDirectory(String projectDir)
      Get the per-project runtime cache directory. Pattern: <projectDir>/.ek9/runtime/

    • getRuntimeJarFile

      public File getRuntimeJarFile(String projectDir, String version, String contentHash)
      Get the cached runtime JAR file path, keyed on the compiler version AND the content hash of the runtime classes - a development build keeps its version while its runtime changes, so the version alone let a stale runtime be packaged (see RuntimeContentHash). Pattern: <projectDir>/.ek9/runtime/ek9-runtime-<version>-<contentHash>.jar

    • validateHomeEk9Directory

      public void validateHomeEk9Directory(TargetArchitecture targetArchitecture)

    • validateEk9Directory

      public void validateEk9Directory(String directoryName, TargetArchitecture targetArchitecture)

    • cleanEk9DirectoryStructureFor

      public void cleanEk9DirectoryStructureFor(File ek9File, TargetArchitecture targetArchitecture)

    • cleanEk9DirectoryStructureFor

      public void cleanEk9DirectoryStructureFor(String ek9FullPathToFileName, TargetArchitecture targetArchitecture)

    • getMainGeneratedOutputDirectory

      public File getMainGeneratedOutputDirectory(String fromEk9BaseDirectory, TargetArchitecture targetArchitecture)

    • getMainFinalOutputDirectory

      public File getMainFinalOutputDirectory(String fromEk9BaseDirectory, TargetArchitecture targetArchitecture)

    • getDevGeneratedOutputDirectory

      public File getDevGeneratedOutputDirectory(String fromEk9BaseDirectory, TargetArchitecture targetArchitecture)

    • getDevFinalOutputDirectory

      public File getDevFinalOutputDirectory(String fromEk9BaseDirectory, TargetArchitecture targetArchitecture)

    • deleteStalePackages

      public void deleteStalePackages(String ek9FileNameDirectory, String moduleName)

    • isUsersSigningKeyPairPresent

      public boolean isUsersSigningKeyPairPresent()

    • getUsersSigningKeyPair

      public SigningKeyPair getUsersSigningKeyPair()

    • saveToHomeEk9Directory

      public boolean saveToHomeEk9Directory(SigningKeyPair keyPair)