Package com.xpn.xwiki.export.html

Class HtmlPackager

java.lang.Object

com.xpn.xwiki.export.html.HtmlPackager

public class HtmlPackager
extends Object

Create a ZIP package containing a range of HTML pages with skin and attachment dependencies.

Since:

XWiki Platform 1.3M1

Version:

$Id: 27e1b0da3a59f5f20687712fc2ba3462047073da $

Constructor Summary

Constructors

Constructor	Description
HtmlPackager()

Method Summary

Modifier and Type	Method	Description
void	addPage(String page)	Deprecated. since 8.4.5/9.0, use addPageReference(DocumentReference) instead
void	addPageReference(DocumentReference pageReference)	Add a page to export.
void	addPageReferences(Collection<DocumentReference> pageReferences)	Add a range of pages to export.
void	addPages(Collection<String> pages)	Deprecated. since 8.4.5/9.0, use addPageReferences(Collection) instead
void	export(XWikiContext context)	Apply export and create the ZIP package.
String	getDescription()
String	getName()
void	setDescription(String description)	Modify the description of the package.
void	setName(String name)	Modify the name of the package for which packager append ".zip".

Methods inherited from class java.lang.Object

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

Constructor Detail

HtmlPackager

public HtmlPackager()

Method Detail

setName

public void setName(String name)

Modify the name of the package for which packager append ".zip".

Parameters:

name - the name of the page.

getName

public String getName()

Returns:

the name of the package for which packager append ".zip".

setDescription

public void setDescription(String description)

Modify the description of the package.

Parameters:

description - the description of the package.

getDescription

public String getDescription()

Returns:

the description of the package.

addPage

@Deprecated
public void addPage(String page)

Deprecated.

since 8.4.5/9.0, use addPageReference(DocumentReference) instead

Add a page to export.

Parameters:

page - the name of the page to export.

addPages

@Deprecated
public void addPages(Collection<String> pages)

Deprecated.

since 8.4.5/9.0, use addPageReferences(Collection) instead

Add a range of pages to export.

Parameters:

pages - a range of pages to export.

addPageReference

public void addPageReference(DocumentReference pageReference)

Add a page to export.

Parameters:

pageReference - the reference of the page to export.

Since:

8.4.5, 9.0

addPageReferences

public void addPageReferences(Collection<DocumentReference> pageReferences)

Add a range of pages to export.

Parameters:

pageReferences - a range of page references to export.

Since:

8.4.5, 9.0

export

public void export(XWikiContext context)
            throws IOException,
                   XWikiException

Apply export and create the ZIP package.

Parameters:

context - the XWiki context used to render pages.

Throws:

IOException - error when creating the package.

XWikiException - error when render the pages.