org.apache.commons.compress.archivers.sevenz.SevenZArchiveEntry Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of commons-compress Show documentation
Show all versions of commons-compress Show documentation
Apache Commons Compress defines an API for working with
compression and archive formats. These include bzip2, gzip, pack200,
LZMA, XZ, Snappy, traditional Unix Compress, DEFLATE, DEFLATE64, LZ4,
Brotli, Zstandard and ar, cpio, jar, tar, zip, dump, 7z, arj.
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.commons.compress.archivers.sevenz;
import java.nio.file.attribute.FileTime;
import java.util.Arrays;
import java.util.Collections;
import java.util.Date;
import java.util.Iterator;
import java.util.LinkedList;
import java.util.Objects;
import org.apache.commons.compress.archivers.ArchiveEntry;
import org.apache.commons.io.file.attribute.FileTimes;
/**
* An entry in a 7z archive.
*
* @NotThreadSafe
* @since 1.6
*/
public class SevenZArchiveEntry implements ArchiveEntry {
static final SevenZArchiveEntry[] EMPTY_SEVEN_Z_ARCHIVE_ENTRY_ARRAY = {};
/**
* Converts Java time to NTFS time.
*
* @param date the Java time
* @return the NTFS time
* @deprecated Use {@link FileTimes#toNtfsTime(Date)} instead.
* @see FileTimes#toNtfsTime(Date)
*/
@Deprecated
public static long javaTimeToNtfsTime(final Date date) {
return FileTimes.toNtfsTime(date);
}
/**
* Converts NTFS time (100 nanosecond units since 1 January 1601) to Java time.
*
* @param ntfsTime the NTFS time in 100 nanosecond units
* @return the Java time
* @deprecated Use {@link FileTimes#ntfsTimeToDate(long)} instead.
* @see FileTimes#ntfsTimeToDate(long)
*/
@Deprecated
public static Date ntfsTimeToJavaTime(final long ntfsTime) {
return FileTimes.ntfsTimeToDate(ntfsTime);
}
private String name;
private boolean hasStream;
private boolean isDirectory;
private boolean isAntiItem;
private boolean hasCreationDate;
private boolean hasLastModifiedDate;
private boolean hasAccessDate;
private FileTime creationDate;
private FileTime lastModifiedDate;
private FileTime accessDate;
private boolean hasWindowsAttributes;
private int windowsAttributes;
private boolean hasCrc;
private long crc, compressedCrc;
private long size, compressedSize;
private Iterable contentMethods;
/**
* Constructs a new instance.
*/
public SevenZArchiveEntry() {
}
@Override
public boolean equals(final Object obj) {
if (this == obj) {
return true;
}
if (obj == null || getClass() != obj.getClass()) {
return false;
}
final SevenZArchiveEntry other = (SevenZArchiveEntry) obj;
return Objects.equals(name, other.name) && hasStream == other.hasStream && isDirectory == other.isDirectory && isAntiItem == other.isAntiItem
&& hasCreationDate == other.hasCreationDate && hasLastModifiedDate == other.hasLastModifiedDate && hasAccessDate == other.hasAccessDate
&& Objects.equals(creationDate, other.creationDate) && Objects.equals(lastModifiedDate, other.lastModifiedDate)
&& Objects.equals(accessDate, other.accessDate) && hasWindowsAttributes == other.hasWindowsAttributes
&& windowsAttributes == other.windowsAttributes && hasCrc == other.hasCrc && crc == other.crc && compressedCrc == other.compressedCrc
&& size == other.size && compressedSize == other.compressedSize && equalSevenZMethods(contentMethods, other.contentMethods);
}
private boolean equalSevenZMethods(final Iterable c1, final Iterable c2) {
if (c1 == null) {
return c2 == null;
}
if (c2 == null) {
return false;
}
final Iterator i2 = c2.iterator();
for (final SevenZMethodConfiguration element : c1) {
if (!i2.hasNext()) {
return false;
}
if (!element.equals(i2.next())) {
return false;
}
}
return !i2.hasNext();
}
/**
* Gets the access date. This is equivalent to {@link SevenZArchiveEntry#getAccessTime()}, but precision is truncated to milliseconds.
*
* @throws UnsupportedOperationException if the entry hasn't got an access date.
* @return the access date
* @see SevenZArchiveEntry#getAccessTime()
*/
public Date getAccessDate() {
return FileTimes.toDate(getAccessTime());
}
/**
* Gets the access time.
*
* @throws UnsupportedOperationException if the entry hasn't got an access time.
* @return the access time
* @since 1.23
*/
public FileTime getAccessTime() {
if (hasAccessDate) {
return accessDate;
}
throw new UnsupportedOperationException("The entry doesn't have this timestamp");
}
/**
* Gets the compressed CRC.
*
* @return the compressed CRC
* @deprecated Use {@link #getCompressedCrcValue()} instead.
*/
@Deprecated
int getCompressedCrc() {
return (int) compressedCrc;
}
/**
* Gets the compressed CRC.
*
* @since 1.7
* @return the CRC
*/
long getCompressedCrcValue() {
return compressedCrc;
}
/**
* Gets this entry's compressed file size.
*
* @return This entry's compressed file size.
*/
long getCompressedSize() {
return compressedSize;
}
/**
* Gets the (compression) methods to use for entry's content - the default is LZMA2.
*
*
* Currently only {@link SevenZMethod#COPY}, {@link SevenZMethod#LZMA2}, {@link SevenZMethod#BZIP2} and {@link SevenZMethod#DEFLATE} are supported when
* writing archives.
*
*
*
* The methods will be consulted in iteration order to create the final output.
*
*
* @since 1.8
* @return the methods to use for the content
*/
public Iterable getContentMethods() {
return contentMethods;
}
/**
* Gets the CRC.
*
* @deprecated use getCrcValue instead.
* @return the CRC
*/
@Deprecated
public int getCrc() {
return (int) crc;
}
/**
* Gets the CRC.
*
* @since 1.7
* @return the CRC
*/
public long getCrcValue() {
return crc;
}
/**
* Gets the creation date. This is equivalent to {@link SevenZArchiveEntry#getCreationTime()}, but precision is truncated to milliseconds.
*
* @throws UnsupportedOperationException if the entry hasn't got a creation date.
* @return the new creation date
* @see SevenZArchiveEntry#getCreationTime()
*/
public Date getCreationDate() {
return FileTimes.toDate(getCreationTime());
}
/**
* Gets the creation time.
*
* @throws UnsupportedOperationException if the entry hasn't got a creation time.
* @return the creation time
* @since 1.23
*/
public FileTime getCreationTime() {
if (hasCreationDate) {
return creationDate;
}
throw new UnsupportedOperationException("The entry doesn't have this timestamp");
}
/**
* Gets whether this entry has got an access date at all.
*
* @return whether this entry has got an access date at all.
*/
public boolean getHasAccessDate() {
return hasAccessDate;
}
/**
* Gets whether this entry has got a crc.
*
*
* In general entries without streams don't have a CRC either.
*
*
* @return whether this entry has got a crc.
*/
public boolean getHasCrc() {
return hasCrc;
}
/**
* Gets whether this entry has got a creation date at all.
*
* @return whether the entry has got a creation date
*/
public boolean getHasCreationDate() {
return hasCreationDate;
}
/**
* Gets whether this entry has got a last modified date at all.
*
* @return whether this entry has got a last modified date at all
*/
public boolean getHasLastModifiedDate() {
return hasLastModifiedDate;
}
/**
* Gets whether this entry has windows attributes.
*
* @return whether this entry has windows attributes.
*/
public boolean getHasWindowsAttributes() {
return hasWindowsAttributes;
}
/**
* Gets the last modified date. This is equivalent to {@link SevenZArchiveEntry#getLastModifiedTime()}, but precision is truncated to milliseconds.
*
* @throws UnsupportedOperationException if the entry hasn't got a last modified date.
* @return the last modified date
* @see SevenZArchiveEntry#getLastModifiedTime()
*/
@Override
public Date getLastModifiedDate() {
return FileTimes.toDate(getLastModifiedTime());
}
/**
* Gets the last modified time.
*
* @throws UnsupportedOperationException if the entry hasn't got a last modified time.
* @return the last modified time
* @since 1.23
*/
public FileTime getLastModifiedTime() {
if (hasLastModifiedDate) {
return lastModifiedDate;
}
throw new UnsupportedOperationException("The entry doesn't have this timestamp");
}
/**
* Gets this entry's name.
*
*
* This method returns the raw name as it is stored inside of the archive.
*
*
* @return This entry's name.
*/
@Override
public String getName() {
return name;
}
/**
* Gets this entry's file size.
*
* @return This entry's file size.
*/
@Override
public long getSize() {
return size;
}
/**
* Gets the windows attributes.
*
* @return the windows attributes
*/
public int getWindowsAttributes() {
return windowsAttributes;
}
@Override
public int hashCode() {
final String n = getName();
return n == null ? 0 : n.hashCode();
}
/**
* Tests whether there is any content associated with this entry.
*
* @return whether there is any content associated with this entry.
*/
public boolean hasStream() {
return hasStream;
}
/**
* Tests whether this is an "anti-item" used in differential backups, meaning it should delete the same file from a previous backup.
*
* @return true if it is an anti-item, false otherwise
*/
public boolean isAntiItem() {
return isAntiItem;
}
/**
* Tests whether or not this entry represents a directory.
*
* @return True if this entry is a directory.
*/
@Override
public boolean isDirectory() {
return isDirectory;
}
/**
* Sets the access date.
*
* @param accessDate the new access date
* @see SevenZArchiveEntry#setAccessTime(FileTime)
*/
public void setAccessDate(final Date accessDate) {
setAccessTime(FileTimes.toFileTime(accessDate));
}
/**
* Sets the access date using NTFS time (100 nanosecond units since 1 January 1601)
*
* @param ntfsAccessDate the access date
*/
public void setAccessDate(final long ntfsAccessDate) {
this.accessDate = FileTimes.ntfsTimeToFileTime(ntfsAccessDate);
}
/**
* Sets the access time.
*
* @param time the new access time
* @since 1.23
*/
public void setAccessTime(final FileTime time) {
hasAccessDate = time != null;
if (hasAccessDate) {
this.accessDate = time;
}
}
/**
* Sets whether this is an "anti-item" used in differential backups, meaning it should delete the same file from a previous backup.
*
* @param isAntiItem true if it is an anti-item, false otherwise
*/
public void setAntiItem(final boolean isAntiItem) {
this.isAntiItem = isAntiItem;
}
/**
* Sets the compressed CRC.
*
* @deprecated use setCompressedCrcValue instead.
* @param crc the CRC
*/
@Deprecated
void setCompressedCrc(final int crc) {
this.compressedCrc = crc;
}
/**
* Sets the compressed CRC.
*
* @since 1.7
* @param crc the CRC
*/
void setCompressedCrcValue(final long crc) {
this.compressedCrc = crc;
}
/**
* Sets this entry's compressed file size.
*
* @param size This entry's new compressed file size.
*/
void setCompressedSize(final long size) {
this.compressedSize = size;
}
/**
* Sets the (compression) methods to use for entry's content - the default is LZMA2.
*
*
* Currently only {@link SevenZMethod#COPY}, {@link SevenZMethod#LZMA2}, {@link SevenZMethod#BZIP2} and {@link SevenZMethod#DEFLATE} are supported when
* writing archives.
*
*
*
* The methods will be consulted in iteration order to create the final output.
*
*
* @param methods the methods to use for the content
* @since 1.8
*/
public void setContentMethods(final Iterable methods) {
if (methods != null) {
final LinkedList l = new LinkedList<>();
methods.forEach(l::addLast);
contentMethods = Collections.unmodifiableList(l);
} else {
contentMethods = null;
}
}
/**
* Sets the (compression) methods to use for entry's content - the default is LZMA2.
*
*
* Currently only {@link SevenZMethod#COPY}, {@link SevenZMethod#LZMA2}, {@link SevenZMethod#BZIP2} and {@link SevenZMethod#DEFLATE} are supported when
* writing archives.
*
*
*
* The methods will be consulted in iteration order to create the final output.
*
*
* @param methods the methods to use for the content
* @since 1.22
*/
public void setContentMethods(final SevenZMethodConfiguration... methods) {
setContentMethods(Arrays.asList(methods));
}
/**
* Sets the CRC.
*
* @deprecated use setCrcValue instead.
* @param crc the CRC
*/
@Deprecated
public void setCrc(final int crc) {
this.crc = crc;
}
/**
* Sets the CRC.
*
* @since 1.7
* @param crc the CRC
*/
public void setCrcValue(final long crc) {
this.crc = crc;
}
/**
* Sets the creation date.
*
* @param creationDate the new creation date
* @see SevenZArchiveEntry#setCreationTime(FileTime)
*/
public void setCreationDate(final Date creationDate) {
setCreationTime(FileTimes.toFileTime(creationDate));
}
/**
* Sets the creation date using NTFS time (100 nanosecond units since 1 January 1601)
*
* @param ntfsCreationDate the creation date
*/
public void setCreationDate(final long ntfsCreationDate) {
this.creationDate = FileTimes.ntfsTimeToFileTime(ntfsCreationDate);
}
/**
* Sets the creation time.
*
* @param time the new creation time
* @since 1.23
*/
public void setCreationTime(final FileTime time) {
hasCreationDate = time != null;
if (hasCreationDate) {
this.creationDate = time;
}
}
/**
* Sets whether or not this entry represents a directory.
*
* @param isDirectory True if this entry is a directory.
*/
public void setDirectory(final boolean isDirectory) {
this.isDirectory = isDirectory;
}
/**
* Sets whether this entry has got an access date at all.
*
* @param hasAcessDate whether this entry has got an access date at all.
*/
public void setHasAccessDate(final boolean hasAcessDate) {
this.hasAccessDate = hasAcessDate;
}
/**
* Sets whether this entry has got a crc.
*
* @param hasCrc whether this entry has got a crc.
*/
public void setHasCrc(final boolean hasCrc) {
this.hasCrc = hasCrc;
}
/**
* Sets whether this entry has got a creation date at all.
*
* @param hasCreationDate whether the entry has got a creation date
*/
public void setHasCreationDate(final boolean hasCreationDate) {
this.hasCreationDate = hasCreationDate;
}
/**
* Sets whether this entry has got a last modified date at all.
*
* @param hasLastModifiedDate whether this entry has got a last modified date at all
*/
public void setHasLastModifiedDate(final boolean hasLastModifiedDate) {
this.hasLastModifiedDate = hasLastModifiedDate;
}
/**
* Sets whether there is any content associated with this entry.
*
* @param hasStream whether there is any content associated with this entry.
*/
public void setHasStream(final boolean hasStream) {
this.hasStream = hasStream;
}
/**
* Sets whether this entry has windows attributes.
*
* @param hasWindowsAttributes whether this entry has windows attributes.
*/
public void setHasWindowsAttributes(final boolean hasWindowsAttributes) {
this.hasWindowsAttributes = hasWindowsAttributes;
}
/**
* Sets the last modified date.
*
* @param lastModifiedDate the new last modified date
* @see SevenZArchiveEntry#setLastModifiedTime(FileTime)
*/
public void setLastModifiedDate(final Date lastModifiedDate) {
setLastModifiedTime(FileTimes.toFileTime(lastModifiedDate));
}
/**
* Sets the last modified date using NTFS time (100 nanosecond units since 1 January 1601)
*
* @param ntfsLastModifiedDate the last modified date
*/
public void setLastModifiedDate(final long ntfsLastModifiedDate) {
this.lastModifiedDate = FileTimes.ntfsTimeToFileTime(ntfsLastModifiedDate);
}
/**
* Sets the last modified time.
*
* @param time the new last modified time
* @since 1.23
*/
public void setLastModifiedTime(final FileTime time) {
hasLastModifiedDate = time != null;
if (hasLastModifiedDate) {
this.lastModifiedDate = time;
}
}
/**
* Sets this entry's name.
*
* @param name This entry's new name.
*/
public void setName(final String name) {
this.name = name;
}
/**
* Sets this entry's file size.
*
* @param size This entry's new file size.
*/
public void setSize(final long size) {
this.size = size;
}
/**
* Sets the windows attributes.
*
* @param windowsAttributes the windows attributes
*/
public void setWindowsAttributes(final int windowsAttributes) {
this.windowsAttributes = windowsAttributes;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy