public class HtmlPackager extends Object
Constructor and Description |
---|
HtmlPackager() |
Modifier and Type | Method and 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".
|
public void setName(String name)
name
- the name of the page.public String getName()
public void setDescription(String description)
description
- the description of the package.public String getDescription()
@Deprecated public void addPage(String page)
addPageReference(DocumentReference)
insteadpage
- the name of the page to export.@Deprecated public void addPages(Collection<String> pages)
addPageReferences(Collection)
insteadpages
- a range of pages to export.public void addPageReference(DocumentReference pageReference)
pageReference
- the reference of the page to export.public void addPageReferences(Collection<DocumentReference> pageReferences)
pageReferences
- a range of page references to export.public void export(XWikiContext context) throws IOException, XWikiException
context
- the XWiki context used to render pages.IOException
- error when creating the package.XWikiException
- error when render the pages.Copyright © 2004–2021 XWiki. All rights reserved.