public class

DefaultExportContext

extends Object
implements ExportContext
java.lang.Object
   ↳ com.atlassian.confluence.importexport.DefaultExportContext

Summary

Public Constructors
DefaultExportContext()
Public Methods
void addExceptionEntities(List<ConfluenceEntityObject> entities, boolean validate)
Helper method to add a collection of entities to the current exception entities
void addExceptionEntity(ConfluenceEntityObject entity)
void addWorkingEntity(ConfluenceEntityObject entity)
Add to the entities to be exported.
ContentTree getContentTree()
List<ConfluenceEntityObject> getExceptionEntities()
File getExportDirectory()
@Deprecated String getExportDirectoryPath()
ExportScope getExportScope()
Set getProcessedIds()
String getScope()
String getType()
User getUser()
List<ConfluenceEntityObject> getWorkingEntities()
The top level entities to be exported.
static DefaultExportContext getXmlBackupInstance()
boolean isExceptionEntity(ConfluenceEntityObject entity)
Entities to be excluded from the export.
boolean isExportAll()
boolean isExportAttachments()
boolean isExportComments()
boolean isExportHierarchy()
boolean isPageInExport(Page page, PageManager pageManager)
void setContentTree(ContentTree contentTree)
void setExportAll(boolean exportAll)
void setExportAttachments(boolean exportAttachments)
void setExportComments(boolean exportComments)
void setExportDirectory(File exportDirectory)
void setExportHierarchy(boolean exportHierarchy)
void setExportScope(ExportScope scope)
@Deprecated void setScope(String scope)
This method is deprecated. since 4.2 use setExportScope(ExportScope)
void setType(String type)
void setUser(User user)
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.atlassian.confluence.importexport.ExportContext

Public Constructors

public DefaultExportContext ()

Public Methods

public void addExceptionEntities (List<ConfluenceEntityObject> entities, boolean validate)

Helper method to add a collection of entities to the current exception entities

Parameters
entities a list of ConfluenceEntityObjects
validate - if true the contents of the list will be type-checked to ensure that they contain nothing other than ConfluenceEntityObject.
Throws
IllegalArgumentException if the list contains something ConfluenceEntityObject and validation is turned on.

public void addExceptionEntity (ConfluenceEntityObject entity)

public void addWorkingEntity (ConfluenceEntityObject entity)

Add to the entities to be exported. This entity will be exported and its children and components may be too.

public ContentTree getContentTree ()

Returns
  • tree of ContentNodes to export (each ContentNode holds a page object).
See Also

public List<ConfluenceEntityObject> getExceptionEntities ()

public File getExportDirectory ()

@Deprecated public String getExportDirectoryPath ()

public ExportScope getExportScope ()

public Set getProcessedIds ()

public String getScope ()

public String getType ()

public User getUser ()

public List<ConfluenceEntityObject> getWorkingEntities ()

The top level entities to be exported. Their children and components will usually be exported too.

public static DefaultExportContext getXmlBackupInstance ()

public boolean isExceptionEntity (ConfluenceEntityObject entity)

Entities to be excluded from the export.

public boolean isExportAll ()

public boolean isExportAttachments ()

public boolean isExportComments ()

public boolean isExportHierarchy ()

public boolean isPageInExport (Page page, PageManager pageManager)

public void setContentTree (ContentTree contentTree)

public void setExportAll (boolean exportAll)

public void setExportAttachments (boolean exportAttachments)

public void setExportComments (boolean exportComments)

public void setExportDirectory (File exportDirectory)

public void setExportHierarchy (boolean exportHierarchy)

public void setExportScope (ExportScope scope)

@Deprecated public void setScope (String scope)

This method is deprecated.
since 4.2 use setExportScope(ExportScope)

public void setType (String type)

public void setUser (User user)