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

Class SevenZOutputFile

java.lang.Object

org.apache.commons.compress.archivers.sevenz.SevenZOutputFile

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class SevenZOutputFile
extends java.lang.Object
implements java.io.Closeable

Writes a 7z file.

Since:

1.6

Constructor Summary

Constructors

Constructor	Description
SevenZOutputFile(java.io.File fileName)	Opens file to write a 7z archive to.
SevenZOutputFile(java.io.File fileName, char[] password)	Opens file to write a 7z archive to.
SevenZOutputFile(java.nio.channels.SeekableByteChannel channel)	Prepares channel to write a 7z archive to.
SevenZOutputFile(java.nio.channels.SeekableByteChannel channel, char[] password)	Prepares channel 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(java.io.File inputFile, java.lang.String entryName)	Creates an archive entry using the inputFile and entryName provided.
SevenZArchiveEntry	createArchiveEntry(java.nio.file.Path inputPath, java.lang.String entryName, java.nio.file.LinkOption... options)	Creates an archive entry using the inputPath and entryName provided.
void	finish()	Finishes the addition of entries to this archive, without closing it.
void	putArchiveEntry(ArchiveEntry archiveEntry)	Deprecated. Use putArchiveEntry(SevenZArchiveEntry).
void	putArchiveEntry(SevenZArchiveEntry archiveEntry)	Records an archive entry to add.
void	setContentCompression(SevenZMethod method)	Sets the default compression method to use for entry contents - the default is LZMA2.
void	setContentMethods(java.lang.Iterable<? extends SevenZMethodConfiguration> methods)	Sets the default (compression) methods to use for entry contents - the default is LZMA2.
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(java.io.InputStream inputStream)	Writes all of the given input stream to the current archive entry.
void	write(java.nio.file.Path path, java.nio.file.OpenOption... options)	Writes all of the given input stream to the current archive entry.

Methods inherited from class java.lang.Object

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

Constructor Detail

SevenZOutputFile

public SevenZOutputFile(java.io.File fileName)
                 throws java.io.IOException

Opens file to write a 7z archive to.

Parameters:

fileName - the file to write to

Throws:

java.io.IOException - if opening the file fails

SevenZOutputFile

public SevenZOutputFile(java.io.File fileName,
                        char[] password)
                 throws java.io.IOException

Opens file to write a 7z archive to.

Parameters:

fileName - the file to write to

password - optional password if the archive has to be encrypted

Throws:

java.io.IOException - if opening the file fails

Since:

1.23

SevenZOutputFile

public SevenZOutputFile(java.nio.channels.SeekableByteChannel channel)
                 throws java.io.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:

java.io.IOException - if the channel cannot be positioned properly

Since:

1.13

SevenZOutputFile

public SevenZOutputFile(java.nio.channels.SeekableByteChannel channel,
                        char[] password)
                 throws java.io.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:

java.io.IOException - if the channel cannot be positioned properly

Since:

1.23

Method Detail

close

public void close()
           throws java.io.IOException

Closes the archive, calling finish() if necessary.

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface java.io.Closeable

Throws:

java.io.IOException - on error

closeArchiveEntry

public void closeArchiveEntry()
                       throws java.io.IOException

Closes the archive entry.

Throws:

java.io.IOException - on error

createArchiveEntry

public SevenZArchiveEntry createArchiveEntry(java.io.File inputFile,
                                             java.lang.String entryName)

Creates an archive entry using the inputFile and entryName provided.

Parameters:

inputFile - file to create an entry from

entryName - the name to use

Returns:

the ArchiveEntry set up with details from the file

createArchiveEntry

public SevenZArchiveEntry createArchiveEntry(java.nio.file.Path inputPath,
                                             java.lang.String entryName,
                                             java.nio.file.LinkOption... options)
                                      throws java.io.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:

java.io.IOException - on error

Since:

1.21

finish

public void finish()
            throws java.io.IOException

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

Throws:

java.io.IOException - if archive is already closed.

putArchiveEntry

@Deprecated
public void putArchiveEntry(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 - describes the entry

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 org.apache.commons.compress.archivers.sevenz.SevenZMethodConfiguration>).

Parameters:

method - the default compression method

setContentMethods

public void setContentMethods(java.lang.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

write

public void write(byte[] b)
           throws java.io.IOException

Writes a byte array to the current archive entry.

Parameters:

b - The byte array to be written.

Throws:

java.io.IOException - on error

write

public void write(byte[] b,
                  int off,
                  int len)
           throws java.io.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:

java.io.IOException - on error

write

public void write(java.io.InputStream inputStream)
           throws java.io.IOException

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

Parameters:

inputStream - the data source.

Throws:

java.io.IOException - if an I/O error occurs.

Since:

1.21

write

public void write(int b)
           throws java.io.IOException

Writes a byte to the current archive entry.

Parameters:

b - The byte to be written.

Throws:

java.io.IOException - on error

write

public void write(java.nio.file.Path path,
                  java.nio.file.OpenOption... options)
           throws java.io.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:

java.io.IOException - if an I/O error occurs.

Since:

1.21