Package org.apache.commons.compress.archivers.tar

Class TarArchiveSparseEntry

  • All Implemented Interfaces:
    TarConstants
    public class TarArchiveSparseEntry
extends Object
implements TarConstants
    This class represents a sparse entry in a Tar archive.

    The C structure for a sparse entry is: 

     struct posix_header {
 struct sparse sp[21]; // TarConstants.SPARSELEN_GNU_SPARSE     - offset 0
 char isextended;      // TarConstants.ISEXTENDEDLEN_GNU_SPARSE - offset 504
 };
    Whereas, "struct sparse" is: 
     struct sparse {
 char offset[12];   // offset 0
 char numbytes[12]; // offset 12
 };

    • Constructor Detail

      • TarArchiveSparseEntry

        public TarArchiveSparseEntry​(byte[] headerBuf)
                      throws IOException
        Construct an entry from an archive's header bytes. File is set to null.
        Parameters:
        headerBuf - The header bytes from a tar archive entry.
        Throws:
        IOException - on unknown format

    • Method Detail

      • isExtended

        public boolean isExtended()

      • getSparseHeaders

        public List<TarArchiveStructSparse> getSparseHeaders()
        Obtains information about the configuration for the sparse entry.
        Returns:
        information about the configuration for the sparse entry.
        Since:
        1.20