Package com.github.junrar

Class Archive

java.lang.Object

com.github.junrar.Archive

All Implemented Interfaces:

Closeable, AutoCloseable, Iterable<FileHeader>

public class Archive
extends Object
implements Closeable, Iterable<FileHeader>

The Main Rar Class; represents a rar Archive

Constructor Summary

Constructors

Constructor	Description
Archive(VolumeManager volumeManager, UnrarCallback unrarCallback, String password)
Archive(File firstVolume)
Archive(File firstVolume, UnrarCallback unrarCallback)
Archive(File firstVolume, UnrarCallback unrarCallback, String password)
Archive(File firstVolume, String password)
Archive(InputStream rarAsStream)
Archive(InputStream rarAsStream, UnrarCallback unrarCallback)
Archive(InputStream rarAsStream, UnrarCallback unrarCallback, String password)
Archive(InputStream rarAsStream, String password)

Method Summary

Modifier and Type	Method	Description
void	bytesReadRead(int count)
void	close()	Close the underlying compressed file.
void	extractFile(FileHeader hd, OutputStream os)	Extract the file specified by the given header and write it to the supplied output stream
SeekableReadOnlyByteChannel	getChannel()
List<FileHeader>	getFileHeaders()
List<BaseBlock>	getHeaders()	Gets all of the headers in the archive.
InputStream	getInputStream(FileHeader hd)	Returns an InputStream that will allow to read the file and stream it.
MainHeader	getMainHeader()
String	getPassword()
UnrarCallback	getUnrarCallback()
Volume	getVolume()
VolumeManager	getVolumeManager()
boolean	isEncrypted()
boolean	isOldFormat()
boolean	isPasswordProtected()
Iterator<FileHeader>	iterator()
FileHeader	nextFileHeader()
void	setPassword(String password)
void	setVolume(Volume volume)
void	setVolumeManager(VolumeManager volumeManager)

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Details

Archive

public Archive(VolumeManager volumeManager,
 UnrarCallback unrarCallback,
 String password)
        throws RarException,
IOException

Throws:

RarException

IOException

Archive

public Archive(File firstVolume)
        throws RarException,
IOException

Throws:

RarException

IOException

Archive

public Archive(File firstVolume,
 UnrarCallback unrarCallback)
        throws RarException,
IOException

Throws:

RarException

IOException

Archive

public Archive(File firstVolume,
 String password)
        throws RarException,
IOException

Throws:

RarException

IOException

Archive

public Archive(File firstVolume,
 UnrarCallback unrarCallback,
 String password)
        throws RarException,
IOException

Throws:

RarException

IOException

Archive

public Archive(InputStream rarAsStream)
        throws RarException,
IOException

Throws:

RarException

IOException

Archive

public Archive(InputStream rarAsStream,
 UnrarCallback unrarCallback)
        throws RarException,
IOException

Throws:

RarException

IOException

Archive

public Archive(InputStream rarAsStream,
 String password)
        throws IOException,
RarException

Throws:

IOException

RarException

Archive

public Archive(InputStream rarAsStream,
 UnrarCallback unrarCallback,
 String password)
        throws IOException,
RarException

Throws:

IOException

RarException

Method Details

bytesReadRead

public void bytesReadRead(int count)

getChannel

public SeekableReadOnlyByteChannel getChannel()

getHeaders

public List<BaseBlock> getHeaders()

Gets all of the headers in the archive.

Returns:

returns the headers.

getFileHeaders

public List<FileHeader> getFileHeaders()

Returns:

returns all file headers of the archive

nextFileHeader

public FileHeader nextFileHeader()

getUnrarCallback

public UnrarCallback getUnrarCallback()

isEncrypted

public boolean isEncrypted()
                    throws RarException

Returns:

whether the archive is encrypted

Throws:

RarException - when the main header is not present

isPasswordProtected

public boolean isPasswordProtected()
                            throws RarException

Returns:

whether the archive content is password protected

Throws:

RarException - when the main header is not present

extractFile

public void extractFile(FileHeader hd,
 OutputStream os)
                 throws RarException

Extract the file specified by the given header and write it to the supplied output stream

Parameters:

hd - the header to be extracted

os - the outputstream

Throws:

RarException - .

getInputStream

public InputStream getInputStream(FileHeader hd)
                           throws IOException

Returns an InputStream that will allow to read the file and stream it.
Please note that this method will create a pair of Pipe streams and either:

• delegate the work to a ThreadPoolExecutor, via Archive.ExtractorExecutorHolder; or
• delegate the work to a newly created thread on each call

You can choose which strategy to use by setting the junrar.extractor.use-executor system property.
Defaults to using the ThreadPoolExecutor.

Parameters:

hd - the header to be extracted

Returns:

an InputStream from which you can read the uncompressed bytes

Throws:

IOException - if any I/O error occur

See Also:

• Archive.ExtractorExecutorHolder

getMainHeader

public MainHeader getMainHeader()

Returns:

returns the main header of this archive

isOldFormat

public boolean isOldFormat()

Returns:

whether the archive is old format

close

public void close()
           throws IOException

Close the underlying compressed file.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

getVolumeManager

public VolumeManager getVolumeManager()

Returns:

the volumeManager

setVolumeManager

public void setVolumeManager(VolumeManager volumeManager)

Parameters:

volumeManager - the volumeManager to set

getVolume

public Volume getVolume()

Returns:

the volume

getPassword

public String getPassword()

setPassword

public void setPassword(String password)

setVolume

public void setVolume(Volume volume)
               throws IOException,
RarException

Parameters:

volume - the volume to set

Throws:

IOException - .

RarException - .

iterator

public Iterator<FileHeader> iterator()

Specified by:

iterator in interface Iterable<FileHeader>