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
  This class is not thread-safe

- - ### Field Summary

    - ### Fields inherited from interface org.apache.commons.compress.archivers.ArchiveEntry

      `SIZE_UNKNOWN`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `SevenZArchiveEntry()`

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `Date` | `getAccessDate()` Gets the access date.
    `Iterable<? extends SevenZMethodConfiguration>` | `getContentMethods()` Gets the (compression) methods to use for entry's content - the default is LZMA2.
    `int` | `getCrc()` Deprecated. use getCrcValue instead.
    `long` | `getCrcValue()` Gets the CRC.
    `Date` | `getCreationDate()` Gets the creation date.
    `boolean` | `getHasAccessDate()` Returns whether this entry has got an access date at all.
    `boolean` | `getHasCrc()` Returns whether this entry has got a crc.
    `boolean` | `getHasCreationDate()` Returns whether this entry has got a creation date at all.
    `boolean` | `getHasLastModifiedDate()` Returns whether this entry has got a last modified date at all.
    `boolean` | `getHasWindowsAttributes()` Returns whether this entry has windows attributes.
    `Date` | `getLastModifiedDate()` Gets the last modified date.
    `String` | `getName()` Get this entry's name.
    `long` | `getSize()` Get this entry's file size.
    `int` | `getWindowsAttributes()` Gets the windows attributes.
    `boolean` | `hasStream()` Whether there is any content associated with this entry.
    `boolean` | `isAntiItem()` Indicates whether this is an "anti-item" used in differential backups, meaning it should delete the same file from a previous backup.
    `boolean` | `isDirectory()` Return whether or not this entry represents a directory.
    `static long` | `javaTimeToNtfsTime(Date date)` Converts Java time to NTFS time.
    `static Date` | `ntfsTimeToJavaTime(long ntfsTime)` Converts NTFS time (100 nanosecond units since 1 January 1601) to Java time.
    `void` | `setAccessDate(Date accessDate)` Sets the access date,
    `void` | `setAccessDate(long ntfsAccessDate)` Sets the access date using NTFS time (100 nanosecond units since 1 January 1601)
    `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.
    `void` | `setContentMethods(Iterable<? extends SevenZMethodConfiguration> methods)` Sets the (compression) methods to use for entry's content - the default is LZMA2.
    `void` | `setCrc(int crc)` Deprecated. use setCrcValue instead.
    `void` | `setCrcValue(long crc)` Sets the CRC.
    `void` | `setCreationDate(Date creationDate)` Sets the creation date,
    `void` | `setCreationDate(long ntfsCreationDate)` Sets the creation date using NTFS time (100 nanosecond units since 1 January 1601)
    `void` | `setDirectory(boolean isDirectory)` Sets whether or not this entry represents a directory.
    `void` | `setHasAccessDate(boolean hasAcessDate)` Sets whether this entry has got an access date at all.
    `void` | `setHasCrc(boolean hasCrc)` Sets whether this entry has got a crc.
    `void` | `setHasCreationDate(boolean hasCreationDate)` Sets whether this entry has got a creation date at all.
    `void` | `setHasLastModifiedDate(boolean hasLastModifiedDate)` Sets whether this entry has got a last modified date at all.
    `void` | `setHasStream(boolean hasStream)` Sets whether there is any content associated with this entry.
    `void` | `setHasWindowsAttributes(boolean hasWindowsAttributes)` Sets whether this entry has windows attributes.
    `void` | `setLastModifiedDate(Date lastModifiedDate)` Sets the last modified date,
    `void` | `setLastModifiedDate(long ntfsLastModifiedDate)` Sets the last modified date using NTFS time (100 nanosecond units since 1 January 1601)
    `void` | `setName(String name)` Set this entry's name.
    `void` | `setSize(long size)` Set this entry's file size.
    `void` | `setWindowsAttributes(int windowsAttributes)` Sets the windows attributes.

    - ### Methods inherited from class java.lang.Object

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

- - ### Constructor Detail

    - #### SevenZArchiveEntry

          public SevenZArchiveEntry()

  - ### Method Detail

    - #### getName

          public String getName()

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

    - #### setName

          public void setName(String name)

      Set this entry's name.
      Parameters:
        `name` - This entry's new name.

    - #### hasStream

          public boolean hasStream()

      Whether there is any content associated with this entry.
      Returns:
        whether there is any content associated with this entry.

    - #### 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.

    - #### isDirectory

          public boolean isDirectory()

      Return whether or not this entry represents a directory.
      Specified by:
        `isDirectory` in interface `ArchiveEntry`
      Returns:
        True if this entry is a directory.

    - #### setDirectory

          public void setDirectory(boolean isDirectory)

      Sets whether or not this entry represents a directory.
      Parameters:
        `isDirectory` - True if this entry is a directory.

    - #### isAntiItem

          public boolean isAntiItem()

      Indicates 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

    - #### 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

    - #### getHasCreationDate

          public boolean getHasCreationDate()

      Returns whether this entry has got a creation date at all.
      Returns:
        whether the entry has got a creation date

    - #### 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

    - #### getCreationDate

          public Date getCreationDate()

      Gets the creation date.
      Returns:
        the creation date
      Throws:
        `UnsupportedOperationException` - if the entry hasn't got a creation date.

    - #### 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

    - #### setCreationDate

          public void setCreationDate(Date creationDate)

      Sets the creation date,
      Parameters:
        `creationDate` - the creation date

    - #### getHasLastModifiedDate

          public boolean getHasLastModifiedDate()

      Returns whether this entry has got a last modified date at all.
      Returns:
        whether this entry has got a last modified date at all

    - #### 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

    - #### getLastModifiedDate

          public Date getLastModifiedDate()

      Gets the last modified date.
      Specified by:
        `getLastModifiedDate` in interface `ArchiveEntry`
      Returns:
        the last modified date
      Throws:
        `UnsupportedOperationException` - if the entry hasn't got a last modified date.

    - #### 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

    - #### setLastModifiedDate

          public void setLastModifiedDate(Date lastModifiedDate)

      Sets the last modified date,
      Parameters:
        `lastModifiedDate` - the last modified date

    - #### getHasAccessDate

          public boolean getHasAccessDate()

      Returns whether this entry has got an access date at all.
      Returns:
        whether this entry has got an access date at all.

    - #### 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.

    - #### getAccessDate

          public Date getAccessDate()

      Gets the access date.
      Returns:
        the access date
      Throws:
        `UnsupportedOperationException` - if the entry hasn't got a access date.

    - #### 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

    - #### setAccessDate

          public void setAccessDate(Date accessDate)

      Sets the access date,
      Parameters:
        `accessDate` - the access date

    - #### getHasWindowsAttributes

          public boolean getHasWindowsAttributes()

      Returns whether this entry has windows attributes.
      Returns:
        whether this entry has windows attributes.

    - #### setHasWindowsAttributes

          public void setHasWindowsAttributes(boolean hasWindowsAttributes)

      Sets whether this entry has windows attributes.
      Parameters:
        `hasWindowsAttributes` - whether this entry has windows attributes.

    - #### getWindowsAttributes

          public int getWindowsAttributes()

      Gets the windows attributes.
      Returns:
        the windows attributes

    - #### setWindowsAttributes

          public void setWindowsAttributes(int windowsAttributes)

      Sets the windows attributes.
      Parameters:
        `windowsAttributes` - the windows attributes

    - #### getHasCrc

          public boolean getHasCrc()

      Returns 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.

    - #### setHasCrc

          public void setHasCrc(boolean hasCrc)

      Sets whether this entry has got a crc.
      Parameters:
        `hasCrc` - whether this entry has got a crc.

    - #### getCrc

          @Deprecated
          public int getCrc()

      Deprecated. use getCrcValue instead.
      Gets the CRC.
      Returns:
        the CRC

    - #### setCrc

          @Deprecated
          public void setCrc(int crc)

      Deprecated. use setCrcValue instead.
      Sets the CRC.
      Parameters:
        `crc` - the CRC

    - #### getCrcValue

          public long getCrcValue()

      Gets the CRC.
      Returns:
        the CRC
      Since:
        Compress 1.7

    - #### setCrcValue

          public void setCrcValue(long crc)

      Sets the CRC.
      Parameters:
        `crc` - the CRC
      Since:
        Compress 1.7

    - #### getSize

          public long getSize()

      Get this entry's file size.
      Specified by:
        `getSize` in interface `ArchiveEntry`
      Returns:
        This entry's file size.

    - #### setSize

          public void setSize(long size)

      Set this entry's file size.
      Parameters:
        `size` - This entry's new 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

    - #### 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

    - #### ntfsTimeToJavaTime

          public static Date ntfsTimeToJavaTime(long ntfsTime)

      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

    - #### javaTimeToNtfsTime

          public static long javaTimeToNtfsTime(Date date)

      Converts Java time to NTFS time.
      Parameters:
        `date` - the Java time
      Returns:
        the NTFS time

Copyright © 2016 The Apache Software Foundation. All rights reserved.