Module kala.compress.archivers.sevenz

Package kala.compress.archivers.sevenz

Class SevenZArchiveWriter

java.lang.Object

kala.compress.archivers.sevenz.SevenZArchiveWriter

All Implemented Interfaces:

Closeable, AutoCloseable

public class SevenZArchiveWriter
extends Object
implements Closeable

Writes a 7z file.

Since:

1.6

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private final class	SevenZArchiveWriter.OutputStreamWrapper

Field Summary

Fields

Modifier and Type	Field	Description
private CountingOutputStream[]	additionalCountingStreams
private final Map<SevenZArchiveEntry,long[]>	additionalSizes
private AES256Options	aes256Options
private final SeekableByteChannel	channel
private final CRC32	compressedCrc32
private Iterable<? extends SevenZMethodConfiguration>	contentMethods
private final CRC32	crc32
private CountingOutputStream	currentOutputStream
private long	fileBytesWritten
private final List<SevenZArchiveEntry>	files
private boolean	finished
private int	numNonEmptyStreams

Constructor Summary

Constructors

Constructor	Description
SevenZArchiveWriter(SeekableByteChannel channel)	Prepares channel to write a 7z archive to.
SevenZArchiveWriter(SeekableByteChannel channel, char[] password)	Prepares channel to write a 7z archive to.
SevenZArchiveWriter(Path file)	Opens file to write a 7z archive to.
SevenZArchiveWriter(Path file, char[] password)	Opens file to write a 7z archive to.

Method Summary

Modifier and Type	Method	Description
void	close()	Closes the archive, calling finish() if necessary.
void	closeArchiveEntry()	Closes the archive entry.
SevenZArchiveEntry	createArchiveEntry(Path inputPath, String entryName, LinkOption... options)	Creates an archive entry using the inputPath and entryName provided.
private void	fillTimes(Path inputPath, SevenZArchiveEntry entry, LinkOption... options)
void	finish()	Finishes the addition of entries to this archive, without closing it.
private Iterable<? extends SevenZMethodConfiguration>	getContentMethods(SevenZArchiveEntry entry)
private OutputStream	getCurrentOutputStream()
void	putArchiveEntry(SevenZArchiveEntry archiveEntry)	Records an archive entry to add.
private static <T> Iterable<T>	reverse(Iterable<T> i)
void	setContentCompression(SevenZMethod method)	Sets the default compression method to use for entry contents - the default is LZMA2.
void	setContentMethods(Iterable<? extends SevenZMethodConfiguration> methods)	Sets the default (compression) methods to use for entry contents - the default is LZMA2.
private CountingOutputStream	setupFileOutputStream()
void	write(byte[] b)	Writes a byte array to the current archive entry.
void	write(byte[] b, int off, int len)	Writes part of a byte array to the current archive entry.
void	write(int b)	Writes a byte to the current archive entry.
void	write(InputStream inputStream)	Writes all of the given input stream to the current archive entry.
void	write(Path path, OpenOption... options)	Writes all of the given input stream to the current archive entry.
private void	writeBits(DataOutput header, BitSet bits, int length)
private void	writeFileAntiItems(DataOutput header)
private void	writeFileATimes(DataOutput header)
private void	writeFileCTimes(DataOutput header)
private void	writeFileEmptyFiles(DataOutput header)
private void	writeFileEmptyStreams(DataOutput header)
private void	writeFileMTimes(DataOutput header)
private void	writeFileNames(DataOutput header)
private void	writeFilesInfo(DataOutput header)
private void	writeFileWindowsAttributes(DataOutput header)
private void	writeFolder(DataOutput header, SevenZArchiveEntry entry)
private void	writeHeader(DataOutput header)
private void	writePackInfo(DataOutput header)
private void	writeSingleCodec(SevenZMethodConfiguration m, OutputStream bos)
private void	writeStreamsInfo(DataOutput header)
private void	writeSubStreamsInfo(DataOutput header)
private void	writeUint64(DataOutput header, long value)
private void	writeUnpackInfo(DataOutput header)

Methods inherited from class java.lang.Object

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

Field Details

channel

private final SeekableByteChannel channel

files

private final List<SevenZArchiveEntry> files

numNonEmptyStreams

private int numNonEmptyStreams

crc32

private final CRC32 crc32

compressedCrc32

private final CRC32 compressedCrc32

fileBytesWritten

private long fileBytesWritten

finished

private boolean finished

currentOutputStream

private CountingOutputStream currentOutputStream

additionalCountingStreams

private CountingOutputStream[] additionalCountingStreams

contentMethods

private Iterable<? extends SevenZMethodConfiguration> contentMethods

additionalSizes

private final Map<SevenZArchiveEntry,long[]> additionalSizes

aes256Options

private AES256Options aes256Options

Constructor Details

SevenZArchiveWriter

public SevenZArchiveWriter(Path file)
                    throws IOException

Opens file to write a 7z archive to.

Parameters:

file - the file to write to

Throws:

IOException - if opening the file fails

Since:

1.27.1-0

SevenZArchiveWriter

public SevenZArchiveWriter(Path file,
 char[] password)
                    throws IOException

Opens file to write a 7z archive to.

Parameters:

file - the file to write to

password - optional password if the archive has to be encrypted

Throws:

IOException - if opening the file fails

Since:

1.27.1-0

SevenZArchiveWriter

public SevenZArchiveWriter(SeekableByteChannel channel)
                    throws IOException

Prepares channel to write a 7z archive to.

SeekableInMemoryByteChannel allows you to write to an in-memory archive.

Parameters:

channel - the channel to write to

Throws:

IOException - if the channel cannot be positioned properly

Since:

1.13

SevenZArchiveWriter

public SevenZArchiveWriter(SeekableByteChannel channel,
 char[] password)
                    throws IOException

Prepares channel to write a 7z archive to.

SeekableInMemoryByteChannel allows you to write to an in-memory archive.

Parameters:

channel - the channel to write to

password - optional password if the archive has to be encrypted

Throws:

IOException - if the channel cannot be positioned properly

Since:

1.23

Method Details

reverse

private static <T> Iterable<T> reverse(Iterable<T> i)

close

public void close()
           throws IOException

Closes the archive, calling finish() if necessary.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException - on error

closeArchiveEntry

public void closeArchiveEntry()
                       throws IOException

Closes the archive entry.

Throws:

IOException - on error

createArchiveEntry

public SevenZArchiveEntry createArchiveEntry(Path inputPath,
 String entryName,
 LinkOption... options)
                                      throws IOException

Creates an archive entry using the inputPath and entryName provided.

Parameters:

inputPath - path to create an entry from

entryName - the name to use

options - options indicating how symbolic links are handled.

Returns:

the ArchiveEntry set up with details from the file

Throws:

IOException - on error

Since:

1.21

fillTimes

private void fillTimes(Path inputPath,
 SevenZArchiveEntry entry,
 LinkOption... options)
                throws IOException

Throws:

IOException

finish

public void finish()
            throws IOException

Finishes the addition of entries to this archive, without closing it.

Throws:

IOException - if archive is already closed.

getContentMethods

private Iterable<? extends SevenZMethodConfiguration> getContentMethods(SevenZArchiveEntry entry)

getCurrentOutputStream

private OutputStream getCurrentOutputStream()
                                     throws IOException

Throws:

IOException

putArchiveEntry

public void putArchiveEntry(SevenZArchiveEntry archiveEntry)

Records an archive entry to add. The caller must then write the content to the archive and call closeArchiveEntry() to complete the process.

Parameters:

archiveEntry - describes the entry

Since:

1.25.0

setContentCompression

public void setContentCompression(SevenZMethod method)

Sets the default compression method to use for entry contents - the default is LZMA2.

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

This is a short form for passing a single-element iterable to setContentMethods(java.lang.Iterable<? extends kala.compress.archivers.sevenz.SevenZMethodConfiguration>).

Parameters:

method - the default compression method

setContentMethods

public void setContentMethods(Iterable<? extends SevenZMethodConfiguration> methods)

Sets the default (compression) methods to use for entry contents - the default is LZMA2.

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

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

Parameters:

methods - the default (compression) methods

Since:

1.8

setupFileOutputStream

private CountingOutputStream setupFileOutputStream()
                                            throws IOException

Throws:

IOException

write

public void write(byte[] b)
           throws IOException

Writes a byte array to the current archive entry.

Parameters:

b - The byte array to be written.

Throws:

IOException - on error

write

public void write(byte[] b,
 int off,
 int len)
           throws IOException

Writes part of a byte array to the current archive entry.

Parameters:

b - The byte array to be written.

off - offset into the array to start writing from

len - number of bytes to write

Throws:

IOException - on error

write

public void write(InputStream inputStream)
           throws IOException

Writes all of the given input stream to the current archive entry.

Parameters:

inputStream - the data source.

Throws:

IOException - if an I/O error occurs.

Since:

1.21

write

public void write(int b)
           throws IOException

Writes a byte to the current archive entry.

Parameters:

b - The byte to be written.

Throws:

IOException - on error

write

public void write(Path path,
 OpenOption... options)
           throws IOException

Writes all of the given input stream to the current archive entry.

Parameters:

path - the data source.

options - options specifying how the file is opened.

Throws:

IOException - if an I/O error occurs.

Since:

1.21

writeBits

private void writeBits(DataOutput header,
 BitSet bits,
 int length)
                throws IOException

Throws:

IOException

writeFileAntiItems

private void writeFileAntiItems(DataOutput header)
                         throws IOException

Throws:

IOException

writeFileATimes

private void writeFileATimes(DataOutput header)
                      throws IOException

Throws:

IOException

writeFileCTimes

private void writeFileCTimes(DataOutput header)
                      throws IOException

Throws:

IOException

writeFileEmptyFiles

private void writeFileEmptyFiles(DataOutput header)
                          throws IOException

Throws:

IOException

writeFileEmptyStreams

private void writeFileEmptyStreams(DataOutput header)
                            throws IOException

Throws:

IOException

writeFileMTimes

private void writeFileMTimes(DataOutput header)
                      throws IOException

Throws:

IOException

writeFileNames

private void writeFileNames(DataOutput header)
                     throws IOException

Throws:

IOException

writeFilesInfo

private void writeFilesInfo(DataOutput header)
                     throws IOException

Throws:

IOException

writeFileWindowsAttributes

private void writeFileWindowsAttributes(DataOutput header)
                                 throws IOException

Throws:

IOException

writeFolder

private void writeFolder(DataOutput header,
 SevenZArchiveEntry entry)
                  throws IOException

Throws:

IOException

writeHeader

private void writeHeader(DataOutput header)
                  throws IOException

Throws:

IOException

writePackInfo

private void writePackInfo(DataOutput header)
                    throws IOException

Throws:

IOException

writeSingleCodec

private void writeSingleCodec(SevenZMethodConfiguration m,
 OutputStream bos)
                       throws IOException

Throws:

IOException

writeStreamsInfo

private void writeStreamsInfo(DataOutput header)
                       throws IOException

Throws:

IOException

writeSubStreamsInfo

private void writeSubStreamsInfo(DataOutput header)
                          throws IOException

Throws:

IOException

writeUint64

private void writeUint64(DataOutput header,
 long value)
                  throws IOException

Throws:

IOException

writeUnpackInfo

private void writeUnpackInfo(DataOutput header)
                      throws IOException

Throws:

IOException