public class

ExportDescriptor

extends Object
java.lang.Object
   ↳ com.atlassian.confluence.importexport.impl.ExportDescriptor

Class Overview

Describes an export, based on the exportDescriptor.properties.

Summary

Public Constructors
ExportDescriptor()
Construct a new ExportDescriptor, most likely with the intention of writing it out.
Public Methods
BuildNumber getBuildNumber()
Get the BuildNumber specified in the exportDescriptor properties file.
static ExportDescriptor getExportDescriptor(File exportZip)
Properties getProperties()
ExportScope getScope()
String getSpaceKey()
boolean isSpaceImport()
void setBackupAttachments(boolean exportAttachments)
void setBuildNumber(String buildNumber)
void setScope(ExportScope scope)
void setSpaceKey(String spaceKey)
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public ExportDescriptor ()

Construct a new ExportDescriptor, most likely with the intention of writing it out. When reading an ExportDescriptor use getExportDescriptor(File).

Public Methods

public BuildNumber getBuildNumber ()

Get the BuildNumber specified in the exportDescriptor properties file. If no descriptor is specified this returns null.

Returns
  • the specified BuildNumber or null

public static ExportDescriptor getExportDescriptor (File exportZip)

Throws
ImportExportException
UnexpectedImportZipFileContents

public Properties getProperties ()

public ExportScope getScope ()

Throws
ExportScope.IllegalExportScopeException

public String getSpaceKey ()

public boolean isSpaceImport ()

public void setBackupAttachments (boolean exportAttachments)

public void setBuildNumber (String buildNumber)

public void setScope (ExportScope scope)

public void setSpaceKey (String spaceKey)