org.xwiki.xar

Class XarFile

java.lang.Object

org.xwiki.xar.XarFile

All Implemented Interfaces:

Closeable, AutoCloseable

public class XarFile
extends Object
implements Closeable

Since:

5.4RC1

Version:

$Id: 458af0038e6dfdd11f9db93589ca3c17c303f74c $

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

Parameters:

file - the XAR file

Throws:

XarException - when failing parse the file (for example if it's not a valid XAR package)

IOException - when failing to read file

XarFile

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

Parameters:

file - the XAR file

pages - the pages in the XAR package

Throws:

XarException - when failing parse the file (for example if it's not a valid XAR package)

IOException - when failing to read file

XarFile

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

Parameters:

file - the XAR file

xarPackage - the descriptor of the XAR package

Throws:

XarException - when failing parse the file (for example if it's not a valid XAR package)

IOException - when failing to read file

Method Detail

getFile

public File getFile()

Returns:

the XAR file

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

Parameters:

reference - the reference of the page

Returns:

an input stream to the page XML

Throws:

IOException - when failing to open a stream to the page XML

getEntries

public Collection<XarEntry> getEntries()

Returns:

the entries in the XAR file

getEntry

public XarEntry getEntry(LocalDocumentReference reference)

Parameters:

reference - the reference of the document

Returns:

the XAR entry associated to a wiki document

toString

public String toString()

Overrides:

toString in class Object