com.atlassian.confluence.importexport
Class DefaultExportContext
java.lang.Object
com.atlassian.confluence.importexport.DefaultExportContext
- All Implemented Interfaces:
- ExportContext
public class DefaultExportContext
- extends java.lang.Object
- implements ExportContext
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
DefaultExportContext
public DefaultExportContext()
getXmlBackupInstance
public static DefaultExportContext getXmlBackupInstance()
getWorkingFile
public java.lang.String getWorkingFile()
setWorkingFile
public void setWorkingFile(java.lang.String workingFile)
addWorkingEntity
public void addWorkingEntity(ConfluenceEntityObject entity)
addExceptionEntities
public void addExceptionEntities(java.util.List entities,
boolean validate)
throws java.lang.IllegalArgumentException
- Helper method to add a collection of entities to the current exception entities
- Parameters:
entities
- validate
- - if true the contents of the list will be type-checked to ensure that they contain
nothing other than ConfluenceEntityObject
.
- Throws:
java.lang.IllegalArgumentException
- if the list contains something ConfluenceEntityObject
and validation is turned on.
addExceptionEntity
public void addExceptionEntity(ConfluenceEntityObject entity)
isPageInExport
public boolean isPageInExport(Page page,
PageManager pageManager)
- Specified by:
isPageInExport
in interface ExportContext
- Returns:
- true if the given page is part of the current export, otherwise false.
getExceptionEntities
public java.util.List getExceptionEntities()
getWorkingEntities
public java.util.List getWorkingEntities()
- Specified by:
getWorkingEntities
in interface ExportContext
getProcessedIds
public java.util.Set getProcessedIds()
- Specified by:
getProcessedIds
in interface ExportContext
getExportDirectoryPath
public java.lang.String getExportDirectoryPath()
- Specified by:
getExportDirectoryPath
in interface ExportContext
setUser
public void setUser(com.atlassian.user.User user)
getUser
public com.atlassian.user.User getUser()
- Specified by:
getUser
in interface ExportContext
- Returns:
- the user this export is being generated for.
getDateFormatter
public DateFormatter getDateFormatter()
- Deprecated. since 2.8.2
- Specified by:
getDateFormatter
in interface ExportContext
- Returns:
DateFormatter
used to format dates and times in PDF & HTML exports.- See Also:
getUser()
setDateFormatter
public void setDateFormatter(DateFormatter dateFormatter)
- Deprecated. since 2.8.2
- See Also:
setUser(User)
isExceptionEntity
public boolean isExceptionEntity(ConfluenceEntityObject entity)
- Specified by:
isExceptionEntity
in interface ExportContext
isExportComments
public boolean isExportComments()
- Specified by:
isExportComments
in interface ExportContext
setExportComments
public void setExportComments(boolean exportComments)
isExportAttachments
public boolean isExportAttachments()
- Specified by:
isExportAttachments
in interface ExportContext
setExportAttachments
public void setExportAttachments(boolean exportAttachments)
- Specified by:
setExportAttachments
in interface ExportContext
isExportHierarchy
public boolean isExportHierarchy()
- Specified by:
isExportHierarchy
in interface ExportContext
setExportHierarchy
public void setExportHierarchy(boolean exportHierarchy)
- Specified by:
setExportHierarchy
in interface ExportContext
getExportDirectory
public java.io.File getExportDirectory()
setExportDirectory
public void setExportDirectory(java.io.File exportDirectory)
getContentTree
public ContentTree getContentTree()
- Returns:
- tree of ContentNodes to export (each ContentNode holds a page object).
- See Also:
ContentTree
setContentTree
public void setContentTree(ContentTree contentTree)
getType
public java.lang.String getType()
- Specified by:
getType
in interface ExportContext
- Returns:
- the type of the export: HTML, PDF or XML. These constants are defined above.
setType
public void setType(java.lang.String type)
getScope
public java.lang.String getScope()
- Specified by:
getScope
in interface ExportContext
- Returns:
- the scope of an XML export: global, space or page. These string constants
are defined on
ImportExportManager
.
setScope
public void setScope(java.lang.String scope)
isExportAll
public boolean isExportAll()
setExportAll
public void setExportAll(boolean exportAll)
Copyright © 2003-2009 Atlassian Pty Ltd. All Rights Reserved.