Package org.apache.commons.compress.archivers.sevenz

Class SevenZArchiveEntry

java.lang.Object
org.apache.commons.compress.archivers.sevenz.SevenZArchiveEntry
All Implemented Interfaces:
ArchiveEntry
public class SevenZArchiveEntry extends Object implements ArchiveEntry
An entry in a 7z archive.
Since:
1.6

  • Field Details

    • EMPTY_SEVEN_Z_ARCHIVE_ENTRY_ARRAY

      static final SevenZArchiveEntry[] EMPTY_SEVEN_Z_ARCHIVE_ENTRY_ARRAY

    • name

      private String name

    • hasStream

      private boolean hasStream

    • isDirectory

      private boolean isDirectory

    • isAntiItem

      private boolean isAntiItem

    • hasCreationDate

      private boolean hasCreationDate

    • hasLastModifiedDate

      private boolean hasLastModifiedDate

    • hasAccessDate

      private boolean hasAccessDate

    • creationDate

      private FileTime creationDate

    • lastModifiedDate

      private FileTime lastModifiedDate

    • accessDate

      private FileTime accessDate

    • hasWindowsAttributes

      private boolean hasWindowsAttributes

    • windowsAttributes

      private int windowsAttributes

    • hasCrc

      private boolean hasCrc

    • crc

      private long crc

    • compressedCrc

      private long compressedCrc

    • size

      private long size

    • compressedSize

      private long compressedSize

    • contentMethods

      private Iterable<? extends SevenZMethodConfiguration> contentMethods

  • Constructor Details

    • SevenZArchiveEntry

      public SevenZArchiveEntry()
      Constructs a new instance.

  • Method Details

    • javaTimeToNtfsTime

      @Deprecated public static long javaTimeToNtfsTime(Date date)
      Deprecated.
      Use TimeUtils.toNtfsTime(Date) instead.
      Converts Java time to NTFS time.
      Parameters:
      date - the Java time
      Returns:
      the NTFS time
      See Also:

    • ntfsTimeToJavaTime

      @Deprecated public static Date ntfsTimeToJavaTime(long ntfsTime)
      Deprecated.
      Use TimeUtils.ntfsTimeToDate(long) instead.
      Converts NTFS time (100 nanosecond units since 1 January 1601) to Java time.
      Parameters:
      ntfsTime - the NTFS time in 100 nanosecond units
      Returns:
      the Java time
      See Also:

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalSevenZMethods

      private boolean equalSevenZMethods(Iterable<? extends SevenZMethodConfiguration> c1, Iterable<? extends SevenZMethodConfiguration> c2)

    • getAccessDate

      public Date getAccessDate()
      Gets the access date. This is equivalent to getAccessTime(), but precision is truncated to milliseconds.
      Returns:
      the access date
      Throws:
      UnsupportedOperationException - if the entry hasn't got an access date.
      See Also:

    • getAccessTime

      public FileTime getAccessTime()
      Gets the access time.
      Returns:
      the access time
      Throws:
      UnsupportedOperationException - if the entry hasn't got an access time.
      Since:
      1.23

    • getCompressedCrc

      @Deprecated int getCompressedCrc()
      Deprecated.
      Use getCompressedCrcValue() instead.
      Gets the compressed CRC.
      Returns:
      the compressed CRC

    • getCompressedCrcValue

      long getCompressedCrcValue()
      Gets the compressed CRC.
      Returns:
      the CRC
      Since:
      1.7

    • getCompressedSize

      long getCompressedSize()
      Gets this entry's compressed file size.
      Returns:
      This entry's compressed file size.

    • getContentMethods

      public Iterable<? extends SevenZMethodConfiguration> getContentMethods()
      Gets the (compression) methods to use for entry's content - the default is LZMA2.

      Currently only SevenZMethod.COPY, SevenZMethod.LZMA2, SevenZMethod.BZIP2 and SevenZMethod.DEFLATE are supported when writing archives.

      The methods will be consulted in iteration order to create the final output.

      Returns:
      the methods to use for the content
      Since:
      1.8

    • getCrc

      @Deprecated public int getCrc()
      Deprecated.
      use getCrcValue instead.
      Gets the CRC.
      Returns:
      the CRC

    • getCrcValue

      public long getCrcValue()
      Gets the CRC.
      Returns:
      the CRC
      Since:
      1.7

    • getCreationDate

      public Date getCreationDate()
      Gets the creation date. This is equivalent to getCreationTime(), but precision is truncated to milliseconds.
      Returns:
      the new creation date
      Throws:
      UnsupportedOperationException - if the entry hasn't got a creation date.
      See Also:

    • getCreationTime

      public FileTime getCreationTime()
      Gets the creation time.
      Returns:
      the creation time
      Throws:
      UnsupportedOperationException - if the entry hasn't got a creation time.
      Since:
      1.23

    • getHasAccessDate

      public boolean getHasAccessDate()
      Gets whether this entry has got an access date at all.
      Returns:
      whether this entry has got an access date at all.

    • getHasCrc

      public boolean getHasCrc()
      Gets whether this entry has got a crc.

      In general entries without streams don't have a CRC either.

      Returns:
      whether this entry has got a crc.

    • getHasCreationDate

      public boolean getHasCreationDate()
      Gets whether this entry has got a creation date at all.
      Returns:
      whether the entry has got a creation date

    • getHasLastModifiedDate

      public boolean getHasLastModifiedDate()
      Gets whether this entry has got a last modified date at all.
      Returns:
      whether this entry has got a last modified date at all

    • getHasWindowsAttributes

      public boolean getHasWindowsAttributes()
      Gets whether this entry has windows attributes.
      Returns:
      whether this entry has windows attributes.

    • getLastModifiedDate

      public Date getLastModifiedDate()
      Gets the last modified date. This is equivalent to getLastModifiedTime(), but precision is truncated to milliseconds.
      Specified by:
      getLastModifiedDate in interface ArchiveEntry
      Returns:
      the last modified date
      Throws:
      UnsupportedOperationException - if the entry hasn't got a last modified date.
      See Also:

    • getLastModifiedTime

      public FileTime getLastModifiedTime()
      Gets the last modified time.
      Returns:
      the last modified time
      Throws:
      UnsupportedOperationException - if the entry hasn't got a last modified time.
      Since:
      1.23

    • getName

      public String getName()
      Gets this entry's name.

      This method returns the raw name as it is stored inside of the archive.

      Specified by:
      getName in interface ArchiveEntry
      Returns:
      This entry's name.

    • getSize

      public long getSize()
      Gets this entry's file size.
      Specified by:
      getSize in interface ArchiveEntry
      Returns:
      This entry's file size.

    • getWindowsAttributes

      public int getWindowsAttributes()
      Gets the windows attributes.
      Returns:
      the windows attributes

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • hasStream

      public boolean hasStream()
      Tests whether there is any content associated with this entry.
      Returns:
      whether there is any content associated with this entry.

    • isAntiItem

      public boolean isAntiItem()
      Tests whether this is an "anti-item" used in differential backups, meaning it should delete the same file from a previous backup.
      Returns:
      true if it is an anti-item, false otherwise

    • isDirectory

      public boolean isDirectory()
      Tests whether or not this entry represents a directory.
      Specified by:
      isDirectory in interface ArchiveEntry
      Returns:
      True if this entry is a directory.

    • setAccessDate

      public void setAccessDate(Date accessDate)
      Sets the access date.
      Parameters:
      accessDate - the new access date
      See Also:

    • setAccessDate

      public void setAccessDate(long ntfsAccessDate)
      Sets the access date using NTFS time (100 nanosecond units since 1 January 1601)
      Parameters:
      ntfsAccessDate - the access date

    • setAccessTime

      public void setAccessTime(FileTime time)
      Sets the access time.
      Parameters:
      time - the new access time
      Since:
      1.23

    • setAntiItem

      public void setAntiItem(boolean isAntiItem)
      Sets whether this is an "anti-item" used in differential backups, meaning it should delete the same file from a previous backup.
      Parameters:
      isAntiItem - true if it is an anti-item, false otherwise

    • setCompressedCrc

      @Deprecated void setCompressedCrc(int crc)
      Deprecated.
      use setCompressedCrcValue instead.
      Sets the compressed CRC.
      Parameters:
      crc - the CRC

    • setCompressedCrcValue

      void setCompressedCrcValue(long crc)
      Sets the compressed CRC.
      Parameters:
      crc - the CRC
      Since:
      1.7

    • setCompressedSize

      void setCompressedSize(long size)
      Sets this entry's compressed file size.
      Parameters:
      size - This entry's new compressed file size.

    • setContentMethods

      public void setContentMethods(Iterable<? extends SevenZMethodConfiguration> methods)
      Sets the (compression) methods to use for entry's content - the default is LZMA2.

      Currently only SevenZMethod.COPY, SevenZMethod.LZMA2, SevenZMethod.BZIP2 and SevenZMethod.DEFLATE are supported when writing archives.

      The methods will be consulted in iteration order to create the final output.

      Parameters:
      methods - the methods to use for the content
      Since:
      1.8

    • setContentMethods

      public void setContentMethods(SevenZMethodConfiguration... methods)
      Sets the (compression) methods to use for entry's content - the default is LZMA2.

      Currently only SevenZMethod.COPY, SevenZMethod.LZMA2, SevenZMethod.BZIP2 and SevenZMethod.DEFLATE are supported when writing archives.

      The methods will be consulted in iteration order to create the final output.

      Parameters:
      methods - the methods to use for the content
      Since:
      1.22

    • setCrc

      @Deprecated public void setCrc(int crc)
      Deprecated.
      use setCrcValue instead.
      Sets the CRC.
      Parameters:
      crc - the CRC

    • setCrcValue

      public void setCrcValue(long crc)
      Sets the CRC.
      Parameters:
      crc - the CRC
      Since:
      1.7

    • setCreationDate

      public void setCreationDate(Date creationDate)
      Sets the creation date.
      Parameters:
      creationDate - the new creation date
      See Also:

    • setCreationDate

      public void setCreationDate(long ntfsCreationDate)
      Sets the creation date using NTFS time (100 nanosecond units since 1 January 1601)
      Parameters:
      ntfsCreationDate - the creation date

    • setCreationTime

      public void setCreationTime(FileTime time)
      Sets the creation time.
      Parameters:
      time - the new creation time
      Since:
      1.23

    • setDirectory

      public void setDirectory(boolean isDirectory)
      Sets whether or not this entry represents a directory.
      Parameters:
      isDirectory - True if this entry is a directory.

    • setHasAccessDate

      public void setHasAccessDate(boolean hasAcessDate)
      Sets whether this entry has got an access date at all.
      Parameters:
      hasAcessDate - whether this entry has got an access date at all.

    • setHasCrc

      public void setHasCrc(boolean hasCrc)
      Sets whether this entry has got a crc.
      Parameters:
      hasCrc - whether this entry has got a crc.

    • setHasCreationDate

      public void setHasCreationDate(boolean hasCreationDate)
      Sets whether this entry has got a creation date at all.
      Parameters:
      hasCreationDate - whether the entry has got a creation date

    • setHasLastModifiedDate

      public void setHasLastModifiedDate(boolean hasLastModifiedDate)
      Sets whether this entry has got a last modified date at all.
      Parameters:
      hasLastModifiedDate - whether this entry has got a last modified date at all

    • setHasStream

      public void setHasStream(boolean hasStream)
      Sets whether there is any content associated with this entry.
      Parameters:
      hasStream - whether there is any content associated with this entry.

    • setHasWindowsAttributes

      public void setHasWindowsAttributes(boolean hasWindowsAttributes)
      Sets whether this entry has windows attributes.
      Parameters:
      hasWindowsAttributes - whether this entry has windows attributes.

    • setLastModifiedDate

      public void setLastModifiedDate(Date lastModifiedDate)
      Sets the last modified date.
      Parameters:
      lastModifiedDate - the new last modified date
      See Also:

    • setLastModifiedDate

      public void setLastModifiedDate(long ntfsLastModifiedDate)
      Sets the last modified date using NTFS time (100 nanosecond units since 1 January 1601)
      Parameters:
      ntfsLastModifiedDate - the last modified date

    • setLastModifiedTime

      public void setLastModifiedTime(FileTime time)
      Sets the last modified time.
      Parameters:
      time - the new last modified time
      Since:
      1.23

    • setName

      public void setName(String name)
      Sets this entry's name.
      Parameters:
      name - This entry's new name.

    • setSize

      public void setSize(long size)
      Sets this entry's file size.
      Parameters:
      size - This entry's new file size.

    • setWindowsAttributes

      public void setWindowsAttributes(int windowsAttributes)
      Sets the windows attributes.
      Parameters:
      windowsAttributes - the windows attributes