org.xwiki.xar

Class XarFile

java.lang.Object

org.xwiki.xar.XarFile

All Implemented Interfaces:

Closeable, AutoCloseable

@Unstable
public class XarFile
extends Object
implements Closeable

Since:

5.4RC1

Version:

$Id: 82da3c265af58c0a7af6ccdd90c2a3f465f145b9 $

Constructor Summary

Constructors

Constructor and Description
XarFile(File file)
XarFile(File file, Collection<XarEntry> pages)
XarFile(File file, XarPackage xarPackage)

Method Summary

Methods

Modifier and Type	Method and Description
void	close()
Collection<XarEntry>	getEntries()
XarEntry	getEntry(LocalDocumentReference reference)
File	getFile()
InputStream	getInputStream(LocalDocumentReference reference)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

XarFile

public XarFile(File file)
        throws XarException,
               IOException

Throws:

XarException

IOException

XarFile

public XarFile(File file,
       Collection<XarEntry> pages)
        throws XarException,
               IOException

Throws:

XarException

IOException

XarFile

public XarFile(File file,
       XarPackage xarPackage)
        throws XarException,
               IOException

Throws:

XarException

IOException

Method Detail

getFile

public File getFile()

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

getInputStream

public InputStream getInputStream(LocalDocumentReference reference)
                           throws IOException

Throws:

IOException

getEntries

public Collection<XarEntry> getEntries()

getEntry

public XarEntry getEntry(LocalDocumentReference reference)

toString

public String toString()

Overrides:

toString in class Object