Package de.uplanet.io

Class TarHelper

java.lang.Object
de.uplanet.io.TarHelper
@Scriptable public final class TarHelper extends Object
IOHelper class utility

  • Constructor Summary

    Constructors
    Constructor
    Description
    TarHelper()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static void
    tarDir(org.apache.commons.compress.archivers.tar.TarArchiveOutputStream p_tar, String p_strRootDir, File p_dirSrc, boolean p_bTarMarkedDirs, Set<File> p_filesToExclude)
    Deprecated.
    static void
    tarDir(org.apache.commons.compress.archivers.tar.TarArchiveOutputStream p_tar, String p_strRootDir, Path p_dirSrc, boolean p_bTarMarkedDirs, Set<Path> p_filesToExclude)
    Copy a directory recursively to a tar output stream.
    p_dest is the parent directory of the new directory
    static void
    tarDir(org.apache.commons.compress.archivers.tar.TarArchiveOutputStream p_tar, String p_strRootDir, Path p_dirSrc, boolean p_bTarMarkedDirs, Set<Path> p_filesToExclude, de.uplanet.util.Progress p_progress)
    Copy a directory recursively to a tar output stream.
    p_dest is the parent directory of the new directory
    static void
    untarDir(File p_fileArchive, String p_strFileNameEncoding, String p_strRootDir, File p_dirDst)
    Deprecated.
    static boolean
    untarDir(File p_fileArchive, String p_strFileNameEncoding, String p_strRootDir, File p_dirDst, de.uplanet.util.Progress p_progress)
    Deprecated.
    static boolean
    untarDirectories(Path p_fileArchive, String p_strFileNameEncoding, Path p_dirDst, de.uplanet.util.Progress p_progress, boolean p_bExclusiveMode, String... p_rootDirs)
    Copy a directory recursively from a tar, tgz or tar.gz file.
    p_dirDst is the parent directory of the new directory.
    static boolean
    untarDirectories(Path p_fileArchive, String p_strFileNameEncoding, Path p_dirDst, de.uplanet.util.Progress p_progress, String... p_rootDirs)
    Copy a directory recursively from a tar, tgz or tar.gz file.
    p_dirDst is the parent directory of the new directory.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • TarHelper

      public TarHelper()

  • Method Details

    • tarDir

      public static void tarDir(org.apache.commons.compress.archivers.tar.TarArchiveOutputStream p_tar, String p_strRootDir, Path p_dirSrc, boolean p_bTarMarkedDirs, Set<Path> p_filesToExclude) throws IOException
      Copy a directory recursively to a tar output stream.
      p_dest is the parent directory of the new directory
      Parameters:
      p_tar - tar output stream
      p_strRootDir - root dir for the added files, or null, if top level
      p_dirSrc - directory to copy
      p_bTarMarkedDirs - zips directories, event if they are marked with a ".noexport" file. If this parameter is set to false, the destination directory entry is created with a .noxexport entry as the only content.
      p_filesToExclude - files which are not exported parameter is set to false, the directory is exported as it would be empty.
      Throws:
      IOException - If an I/O-error occurs.

    • tarDir

      public static void tarDir(org.apache.commons.compress.archivers.tar.TarArchiveOutputStream p_tar, String p_strRootDir, Path p_dirSrc, boolean p_bTarMarkedDirs, Set<Path> p_filesToExclude, de.uplanet.util.Progress p_progress) throws IOException
      Copy a directory recursively to a tar output stream.
      p_dest is the parent directory of the new directory
      Parameters:
      p_tar - tar output stream
      p_strRootDir - root dir for the added files, or null, if top level
      p_dirSrc - directory to copy
      p_bTarMarkedDirs - zips directories, event if they are marked with a ".noexport" file. If this parameter is set to false, the destination directory entry is created with a .noxexport entry as the only content.
      p_filesToExclude - files which are not exported
      p_progress - The progress (could be null). parameter is set to false, the directory is exported as it would be empty.
      Throws:
      IOException - If an I/O-error occurs.
      Since:
      11.9

    • untarDirectories

      public static boolean untarDirectories(Path p_fileArchive, String p_strFileNameEncoding, Path p_dirDst, de.uplanet.util.Progress p_progress, String... p_rootDirs) throws IOException
      Copy a directory recursively from a tar, tgz or tar.gz file.
      p_dirDst is the parent directory of the new directory. If p_progess is null the extraction will be faster, because we not need to calculate the numbers of files, for returning a progress.
      Parameters:
      p_fileArchive - The file to be untared.
      p_strFileNameEncoding - encoding used for file names in tar archive
      p_dirDst - The destination directory.
      p_progress - The progress callback to be used. May be null.
      p_rootDirs - The root dirs of the files in the archive, or null, if top level.
      Returns:
      true, if this method created any files or directories, false otherwise
      Throws:
      IOException - If an I/O-error occurs.

    • untarDirectories

      public static boolean untarDirectories(Path p_fileArchive, String p_strFileNameEncoding, Path p_dirDst, de.uplanet.util.Progress p_progress, boolean p_bExclusiveMode, String... p_rootDirs) throws IOException
      Copy a directory recursively from a tar, tgz or tar.gz file.
      p_dirDst is the parent directory of the new directory. If p_progess is null the extraction will be faster, because we not need to calculate the numbers of files, for returning a progress.
      Parameters:
      p_fileArchive - The file to be untared.
      p_strFileNameEncoding - encoding used for file names in tar archive
      p_dirDst - The destination directory.
      p_progress - The progress callback to be used. May be null.
      p_bExclusiveMode - if true All files/directories not in p_rootDirs will untared otherwise only files/directories set in p_rootDirs will be untared.
      p_rootDirs - The root dirs of the files in the archive, or null, if top level.
      Returns:
      true, if this method created any files or directories, false otherwise
      Throws:
      IOException - If an I/O-error occurs.

    • tarDir

      @Deprecated public static void tarDir(org.apache.commons.compress.archivers.tar.TarArchiveOutputStream p_tar, String p_strRootDir, File p_dirSrc, boolean p_bTarMarkedDirs, Set<File> p_filesToExclude) throws IOException
      Deprecated.
      Throws:
      IOException

    • untarDir

      @Deprecated public static void untarDir(File p_fileArchive, String p_strFileNameEncoding, String p_strRootDir, File p_dirDst) throws IOException
      Deprecated.
      Throws:
      IOException

    • untarDir

      @Deprecated public static boolean untarDir(File p_fileArchive, String p_strFileNameEncoding, String p_strRootDir, File p_dirDst, de.uplanet.util.Progress p_progress) throws IOException
      Deprecated.
      Throws:
      IOException