Modifier and Type	Class and Description
private class	SevenZOutputFile.OutputStreamWrapper

Modifier and Type	Field and 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

Access	Constructor and Description
public	SevenZOutputFile(final File the file to write to fileName) Opens file to write a 7z archive to.
public	SevenZOutputFile(final File the file to write to fileName, final char[] optional password if the archive has to be encrypted password) Opens file to write a 7z archive to.
public	SevenZOutputFile(final SeekableByteChannel the channel to write to channel) Prepares channel to write a 7z archive to.
public	SevenZOutputFile(final SeekableByteChannel the channel to write to channel, final char[] optional password if the archive has to be encrypted password) Prepares channel to write a 7z archive to.

Method Summary

Modifier and Type	Method and Description
public void	close() Implements java.io.Closeable.close. Closes the archive, calling `finish` if necessary.
public void	closeArchiveEntry() Closes the archive entry.
public SevenZArchiveEntry	Returns: the ArchiveEntry set up with details from the file createArchiveEntry(final File file to create an entry from inputFile, final String the name to use entryName) Creates an archive entry using the inputFile and entryName provided.
public SevenZArchiveEntry	Returns: the ArchiveEntry set up with details from the file createArchiveEntry(final Path path to create an entry from inputPath, final String the name to use entryName, final LinkOption... options indicating how symbolic links are handled. options) Creates an archive entry using the inputPath and entryName provided.
private void	fillDates(final Path inputPath, final SevenZArchiveEntry entry, final LinkOption... options)
public void	finish() Finishes the addition of entries to this archive, without closing it.
private Iterable<? extends SevenZMethodConfiguration>	getContentMethods(final SevenZArchiveEntry entry)
private OutputStream	getCurrentOutputStream()
public void	putArchiveEntry(final ArchiveEntry describes the entry archiveEntry) Deprecated Use `putArchiveEntry(SevenZArchiveEntry)`. Records an archive entry to add.
public void	putArchiveEntry(final SevenZArchiveEntry describes the entry archiveEntry) Records an archive entry to add.
private static <T> Iterable<T>	reverse(final Iterable<T> i)
public void	setContentCompression(final SevenZMethod the default compression method method) Sets the default compression method to use for entry contents - the default is LZMA2.
public void	setContentMethods(final Iterable<? extends SevenZMethodConfiguration> the default (compression) methods methods) Sets the default (compression) methods to use for entry contents - the default is LZMA2.
private CountingOutputStream	setupFileOutputStream()
public void	write(final byte[] The byte array to be written. b) Writes a byte array to the current archive entry.
public void	write(final byte[] The byte array to be written. b, final int offset into the array to start writing from off, final int number of bytes to write len) Writes part of a byte array to the current archive entry.
public void	write(final InputStream the data source. inputStream) Writes all of the given input stream to the current archive entry.
public void	write(final int The byte to be written. b) Writes a byte to the current archive entry.
public void	write(final Path the data source. path, final OpenOption... options specifying how the file is opened. options) Writes all of the given input stream to the current archive entry.
private void	writeBits(final DataOutput header, final BitSet bits, final int length)
private void	writeFileAntiItems(final DataOutput header)
private void	writeFileATimes(final DataOutput header)
private void	writeFileCTimes(final DataOutput header)
private void	writeFileEmptyFiles(final DataOutput header)
private void	writeFileEmptyStreams(final DataOutput header)
private void	writeFileMTimes(final DataOutput header)
private void	writeFileNames(final DataOutput header)
private void	writeFilesInfo(final DataOutput header)
private void	writeFileWindowsAttributes(final DataOutput header)
private void	writeFolder(final DataOutput header, final SevenZArchiveEntry entry)
private void	writeHeader(final DataOutput header)
private void	writePackInfo(final DataOutput header)
private void	writeSingleCodec(final SevenZMethodConfiguration m, final OutputStream bos)
private void	writeStreamsInfo(final DataOutput header)
private void	writeSubStreamsInfo(final DataOutput header)
private void	writeUint64(final DataOutput header, long value)
private void	writeUnpackInfo(final DataOutput header)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

additionalCountingStreams	back to summary
private CountingOutputStream[] additionalCountingStreams

additionalSizes	back to summary
private final Map<SevenZArchiveEntry, long[]> additionalSizes

aes256Options	back to summary
private AES256Options aes256Options

channel	back to summary
private final SeekableByteChannel channel

compressedCrc32	back to summary
private final CRC32 compressedCrc32

contentMethods	back to summary
private Iterable<? extends SevenZMethodConfiguration> contentMethods

crc32	back to summary
private final CRC32 crc32

currentOutputStream	back to summary
private CountingOutputStream currentOutputStream

fileBytesWritten	back to summary
private long fileBytesWritten

files	back to summary
private final List<SevenZArchiveEntry> files

finished	back to summary
private boolean finished

numNonEmptyStreams	back to summary
private int numNonEmptyStreams

Constructor Detail

SevenZOutputFile	back to summary
public SevenZOutputFile(final File fileName) throws IOException Opens file to write a 7z archive to. Parameters fileName:File the file to write to Exceptions IOException: if opening the file fails

SevenZOutputFile

back to summary

public SevenZOutputFile(final File fileName) throws IOException

Opens file to write a 7z archive to.

Parameters

fileName:File: the file to write to

Exceptions

IOException:: if opening the file fails

SevenZOutputFile	back to summary
public SevenZOutputFile(final File fileName, final char[] password) throws IOException Opens file to write a 7z archive to. Parameters fileName:File the file to write to password:char[] optional password if the archive has to be encrypted Exceptions IOException: if opening the file fails Since 1.23

SevenZOutputFile

back to summary

public SevenZOutputFile(final File fileName, final char[] password) throws IOException

Opens file to write a 7z archive to.

Parameters

fileName:File: the file to write to
password:char[]: optional password if the archive has to be encrypted

Exceptions

IOException:: if opening the file fails

Since

1.23

SevenZOutputFile back to summary

SevenZOutputFile	back to summary
public SevenZOutputFile(final SeekableByteChannel channel) throws IOException Prepares channel to write a 7z archive to. `org.apache.commons.compress.utils.SeekableInMemoryByteChannel` allows you to write to an in-memory archive. Parameters channel:SeekableByteChannel the channel to write to Exceptions IOException: if the channel cannot be positioned properly Since 1.13

public SevenZOutputFile(final SeekableByteChannel channel) throws IOException

Prepares channel to write a 7z archive to.

org.apache.commons.compress.utils.SeekableInMemoryByteChannel allows you to write to an in-memory archive.

Parameters

channel:SeekableByteChannel: the channel to write to

Exceptions

IOException:: if the channel cannot be positioned properly

Since

1.13

SevenZOutputFile back to summary

SevenZOutputFile	back to summary
public SevenZOutputFile(final SeekableByteChannel channel, final char[] password) throws IOException Prepares channel to write a 7z archive to. `org.apache.commons.compress.utils.SeekableInMemoryByteChannel` allows you to write to an in-memory archive. Parameters channel:SeekableByteChannel the channel to write to password:char[] optional password if the archive has to be encrypted Exceptions IOException: if the channel cannot be positioned properly Since 1.23

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

Prepares channel to write a 7z archive to.

org.apache.commons.compress.utils.SeekableInMemoryByteChannel allows you to write to an in-memory archive.

Parameters

channel:SeekableByteChannel: the channel to write to
password:char[]: optional password if the archive has to be encrypted

Exceptions

IOException:: if the channel cannot be positioned properly

Since

1.23

Method Detail

close back to summary

close	back to summary
public void close() throws IOException Implements java.io.Closeable.close. Closes the archive, calling `finish` if necessary. Annotations @Override Exceptions IOException: on error

public void close() throws IOException

Implements java.io.Closeable.close.

Closes the archive, calling finish if necessary.

Annotations

@Override

Exceptions

IOException:: on error

closeArchiveEntry	back to summary
public void closeArchiveEntry() throws IOException Closes the archive entry. Exceptions IOException: on error

closeArchiveEntry

back to summary

public void closeArchiveEntry() throws IOException

Closes the archive entry.

Exceptions

IOException:: on error

createArchiveEntry	back to summary
public SevenZArchiveEntry createArchiveEntry(final File inputFile, final String entryName) Creates an archive entry using the inputFile and entryName provided. Parameters inputFile:File file to create an entry from entryName:String the name to use Returns:SevenZArchiveEntry the ArchiveEntry set up with details from the file

createArchiveEntry

back to summary

public SevenZArchiveEntry createArchiveEntry(final File inputFile, final String entryName)

Creates an archive entry using the inputFile and entryName provided.

Parameters

inputFile:File: file to create an entry from
entryName:String: the name to use

Returns:SevenZArchiveEntry

the ArchiveEntry set up with details from the file

createArchiveEntry	back to summary
public SevenZArchiveEntry createArchiveEntry(final Path inputPath, final String entryName, final LinkOption... options) throws IOException Creates an archive entry using the inputPath and entryName provided. Parameters inputPath:Path path to create an entry from entryName:String the name to use options:LinkOption[] options indicating how symbolic links are handled. Returns:SevenZArchiveEntry the ArchiveEntry set up with details from the file Exceptions IOException: on error Since 1.21

createArchiveEntry

back to summary

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

Creates an archive entry using the inputPath and entryName provided.

Parameters

inputPath:Path: path to create an entry from
entryName:String: the name to use
options:LinkOption[]: options indicating how symbolic links are handled.

Returns:SevenZArchiveEntry

the ArchiveEntry set up with details from the file

Exceptions

IOException:: on error

Since

1.21

fillDates	back to summary
private void fillDates(final Path inputPath, final SevenZArchiveEntry entry, final LinkOption... options) throws IOException

finish	back to summary
public void finish() throws IOException Finishes the addition of entries to this archive, without closing it. Exceptions IOException: if archive is already closed.

finish

back to summary

public void finish() throws IOException

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

Exceptions

IOException:: if archive is already closed.

getContentMethods	back to summary
private Iterable<? extends SevenZMethodConfiguration> getContentMethods(final SevenZArchiveEntry entry)

getCurrentOutputStream	back to summary
private OutputStream getCurrentOutputStream() throws IOException

putArchiveEntry back to summary

putArchiveEntry	back to summary
public void putArchiveEntry(final ArchiveEntry archiveEntry) Deprecated Use `putArchiveEntry(SevenZArchiveEntry)`. 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:ArchiveEntry describes the entry Annotations @Deprecated

public void putArchiveEntry(final ArchiveEntry archiveEntry)

Deprecated

Use putArchiveEntry(SevenZArchiveEntry).

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:ArchiveEntry: describes the entry

Annotations

@Deprecated

putArchiveEntry back to summary

putArchiveEntry	back to summary
public void putArchiveEntry(final 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:SevenZArchiveEntry describes the entry Since 1.25.0

public void putArchiveEntry(final 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:SevenZArchiveEntry: describes the entry

Since

1.25.0

reverse	back to summary
private static <T> Iterable<T> reverse(final Iterable<T> i)

setContentCompression back to summary

setContentCompression	back to summary
public void setContentCompression(final 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`. Parameters method:SevenZMethod the default compression method

public void setContentCompression(final 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.

Parameters

method:SevenZMethod: the default compression method

setContentMethods back to summary

setContentMethods	back to summary
public void setContentMethods(final 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:Iterable<? extends SevenZMethodConfiguration> the default (compression) methods Since 1.8

public void setContentMethods(final 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:Iterable<? extends SevenZMethodConfiguration>: the default (compression) methods

Since

1.8

setupFileOutputStream	back to summary
private CountingOutputStream setupFileOutputStream() throws IOException

write	back to summary
public void write(final byte[] b) throws IOException Writes a byte array to the current archive entry. Parameters b:byte[] The byte array to be written. Exceptions IOException: on error

write

back to summary

public void write(final byte[] b) throws IOException

Writes a byte array to the current archive entry.

Parameters

b:byte[]: The byte array to be written.

Exceptions

IOException:: on error

write	back to summary
public void write(final byte[] b, final int off, final int len) throws IOException Writes part of a byte array to the current archive entry. Parameters b:byte[] The byte array to be written. off:int offset into the array to start writing from len:int number of bytes to write Exceptions IOException: on error

write

back to summary

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

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

Parameters

b:byte[]: The byte array to be written.
off:int: offset into the array to start writing from
len:int: number of bytes to write

Exceptions

IOException:: on error

write	back to summary
public void write(final InputStream inputStream) throws IOException Writes all of the given input stream to the current archive entry. Parameters inputStream:InputStream the data source. Exceptions IOException: if an I/O error occurs. Since 1.21

write

back to summary

public void write(final InputStream inputStream) throws IOException

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

Parameters

inputStream:InputStream: the data source.

Exceptions

IOException:: if an I/O error occurs.

Since

1.21

write	back to summary
public void write(final int b) throws IOException Writes a byte to the current archive entry. Parameters b:int The byte to be written. Exceptions IOException: on error

write

back to summary

public void write(final int b) throws IOException

Writes a byte to the current archive entry.

Parameters

b:int: The byte to be written.

Exceptions

IOException:: on error

write	back to summary
public void write(final Path path, final OpenOption... options) throws IOException Writes all of the given input stream to the current archive entry. Parameters path:Path the data source. options:OpenOption[] options specifying how the file is opened. Exceptions IOException: if an I/O error occurs. Since 1.21

write

back to summary

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

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

Parameters

path:Path: the data source.
options:OpenOption[]: options specifying how the file is opened.

Exceptions

IOException:: if an I/O error occurs.

Since

1.21

writeBits	back to summary
private void writeBits(final DataOutput header, final BitSet bits, final int length) throws IOException

writeFileAntiItems	back to summary
private void writeFileAntiItems(final DataOutput header) throws IOException

writeFileATimes	back to summary
private void writeFileATimes(final DataOutput header) throws IOException

writeFileCTimes	back to summary
private void writeFileCTimes(final DataOutput header) throws IOException

writeFileEmptyFiles	back to summary
private void writeFileEmptyFiles(final DataOutput header) throws IOException

writeFileEmptyStreams	back to summary
private void writeFileEmptyStreams(final DataOutput header) throws IOException

writeFileMTimes	back to summary
private void writeFileMTimes(final DataOutput header) throws IOException

writeFileNames	back to summary
private void writeFileNames(final DataOutput header) throws IOException

writeFilesInfo	back to summary
private void writeFilesInfo(final DataOutput header) throws IOException

writeFileWindowsAttributes	back to summary
private void writeFileWindowsAttributes(final DataOutput header) throws IOException

writeFolder	back to summary
private void writeFolder(final DataOutput header, final SevenZArchiveEntry entry) throws IOException

writeHeader	back to summary
private void writeHeader(final DataOutput header) throws IOException

writePackInfo	back to summary
private void writePackInfo(final DataOutput header) throws IOException

writeSingleCodec	back to summary
private void writeSingleCodec(final SevenZMethodConfiguration m, final OutputStream bos) throws IOException

writeStreamsInfo	back to summary
private void writeStreamsInfo(final DataOutput header) throws IOException

writeSubStreamsInfo	back to summary
private void writeSubStreamsInfo(final DataOutput header) throws IOException

writeUint64	back to summary
private void writeUint64(final DataOutput header, long value) throws IOException

writeUnpackInfo	back to summary
private void writeUnpackInfo(final DataOutput header) throws IOException

org.apache.commons.compress.archivers.sevenz back to summary

private final Class SevenZOutputFile.OutputStreamWrapper

Class Inheritance

extends OutputStream

java.lang.Object
java.io.OutputStream
org.apache.commons.compress.archivers.sevenz.SevenZOutputFile.OutputStreamWrapper

Field Summary

Modifier and Type	Field and Description
private static final int	BUF_SIZE
private final ByteBuffer	buffer

Constructor Summary

Access	Constructor and Description
private	OutputStreamWrapper()

Method Summary

Modifier and Type	Method and Description
public void	close() Overrides java.io.OutputStream.close. Implements java.io.Closeable.close. Closes this output stream and releases any system resources associated with this stream.
public void	flush() Overrides java.io.OutputStream.flush. Implements java.io.Flushable.flush. Flushes this output stream and forces any buffered output bytes to be written out.
public void	write(final byte[] the data. b) Overrides java.io.OutputStream.write. Writes `b.length` bytes from the specified byte array to this output stream.
public void	write(final byte[] the data. b, final int the start offset in the data. off, final int the number of bytes to write. len) Overrides java.io.OutputStream.write. Writes `len` bytes from the specified byte array starting at offset `off` to this output stream.
public void	write(final int the `byte`. b) Implements abstract java.io.OutputStream.write. Writes the specified byte to this output stream.

Inherited from java.io.OutputStream:: nullOutputStream

Field Detail

BUF_SIZE	back to summary
private static final int BUF_SIZE

buffer	back to summary
private final ByteBuffer buffer

Constructor Detail

OutputStreamWrapper	back to summary
private OutputStreamWrapper()

Method Detail

close back to summary

public void close() throws IOException

Overrides java.io.OutputStream.close.

Implements java.io.Closeable.close.

Doc from java.io.OutputStream.close.

Closes this output stream and releases any system resources associated with this stream. The general contract of close is that it closes the output stream. A closed stream cannot perform output operations and cannot be reopened.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

flush back to summary

public void flush() throws IOException

Overrides java.io.OutputStream.flush.

Implements java.io.Flushable.flush.

Doc from java.io.OutputStream.flush.

Flushes this output stream and forces any buffered output bytes to be written out. The general contract of flush is that calling it is an indication that, if any bytes previously written have been buffered by the implementation of the output stream, such bytes should immediately be written to their intended destination.

If the intended destination of this stream is an abstraction provided by the underlying operating system, for example a file, then flushing the stream guarantees only that bytes previously written to the stream are passed to the operating system for writing; it does not guarantee that they are actually written to a physical device such as a disk drive.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

write back to summary

public void write(final byte[] b) throws IOException

Overrides java.io.OutputStream.write.

Doc from java.io.OutputStream.write.

Writes b.length bytes from the specified byte array to this output stream. The general contract for write(b) is that it should have exactly the same effect as the call write(b, 0, b.length).

Parameters

b:byte[]: the data.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

write back to summary

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

Overrides java.io.OutputStream.write.

Doc from java.io.OutputStream.write.

Writes len bytes from the specified byte array starting at offset off to this output stream. The general contract for write(b, off, len) is that some of the bytes in the array b are written to the output stream in order; element b[off] is the first byte written and b[off+len-1] is the last byte written by this operation.

If b is null, a NullPointerException is thrown.

If off is negative, or len is negative, or off+len is greater than the length of the array b, then an IndexOutOfBoundsException is thrown.

Parameters

b:byte[]: the data.
off:int: the start offset in the data.
len:int: the number of bytes to write.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs. In particular, an IOException is thrown if the output stream is closed.

write back to summary

public void write(final int b) throws IOException

Implements abstract java.io.OutputStream.write.

Doc from java.io.OutputStream.write.

Writes the specified byte to this output stream. The general contract for write is that one byte is written to the output stream. The byte to be written is the eight low-order bits of the argument b. The 24 high-order bits of b are ignored.

Parameters

b:int: the byte.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs. In particular, an IOException may be thrown if the output stream has been closed.

public Class SevenZOutputFile

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class SevenZOutputFile.OutputStreamWrapper

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail