org.xwiki.wikistream.xar.output
Class XAROutputProperties

java.lang.Object
  org.xwiki.wikistream.DefaultWikiStreamProperties
      org.xwiki.wikistream.xml.XMLProperties
          org.xwiki.wikistream.xml.output.XMLOutputProperties
              org.xwiki.wikistream.xar.output.XAROutputProperties

All Implemented Interfaces:

org.xwiki.wikistream.WikiStreamProperties

@Unstable
public class XAROutputProperties
extends XMLOutputProperties

XAR output properties.

Since:

5.3RC1

Version:

$Id: fa0bcb09fde5544896982a703470c4e09f3fa88d $

Constructor Summary

XAROutputProperties()

Method Summary

String	getPackageAuthor()
String	getPackageDescription()
String	getPackageExtensionId()
String	getPackageLicense()
String	getPackageName()
String	getPackageVersion()
boolean	isForceDocument()
boolean	isPackageBackupPack()
boolean	isPreserveVersion()
void	setForceDocument(boolean forceDocument)
void	setPackageAuthor(String packageAuthor)
void	setPackageBackupPack(boolean packageBackupPack)
void	setPackageDescription(String packageDescription)
void	setPackageExtensionId(String packageExtensionId)
void	setPackageLicense(String packageLicense)
void	setPackageName(String packageName)
void	setPackageVersion(String packageVersion)
void	setPreserveVersion(boolean preserveVersion)

Methods inherited from class org.xwiki.wikistream.xml.output.XMLOutputProperties

getEncoding, getTarget, isFormat, setEncoding, setFormat, setTarget

Methods inherited from class org.xwiki.wikistream.DefaultWikiStreamProperties

isVerbose, setVerbose

Methods inherited from class java.lang.Object

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

Constructor Detail

XAROutputProperties

public XAROutputProperties()

Method Detail

isPreserveVersion

public boolean isPreserveVersion()

Returns:

Indicate if all revisions related informations should be serialized

setPreserveVersion

public void setPreserveVersion(boolean preserveVersion)

Parameters:

preserveVersion - Indicate if all revisions related informations should be serialized

isForceDocument

public boolean isForceDocument()

Returns:

true if a unique document should be serialized instead of a XAR package

setForceDocument

public void setForceDocument(boolean forceDocument)

Parameters:

forceDocument - true if a unique document should be serialized instead of a XAR package

getPackageName

public String getPackageName()

Returns:

Indicate if all revisions related informations should be serialized

setPackageName

public void setPackageName(String packageName)

Parameters:

packageName - Indicate if all revisions related informations should be serialized

getPackageDescription

public String getPackageDescription()

Returns:

The description to put in package.xml

setPackageDescription

public void setPackageDescription(String packageDescription)

Parameters:

packageDescription - The description to put in package.xml

getPackageLicense

public String getPackageLicense()

Returns:

"The licence to put in package.xml

setPackageLicense

public void setPackageLicense(String packageLicense)

Parameters:

packageLicense - "The licence to put in package.xml

getPackageAuthor

public String getPackageAuthor()

Returns:

The author to put in package.xml

setPackageAuthor

public void setPackageAuthor(String packageAuthor)

Parameters:

packageAuthor - The author to put in package.xml

getPackageVersion

public String getPackageVersion()

Returns:

The version to put in package.xml

setPackageVersion

public void setPackageVersion(String packageVersion)

Parameters:

packageVersion - The version to put in package.xml

isPackageBackupPack

public boolean isPackageBackupPack()

Returns:

Indicate in package.xml if the XAR is a backup pack

setPackageBackupPack

public void setPackageBackupPack(boolean packageBackupPack)

Parameters:

packageBackupPack - Indicate in package.xml if the XAR is a backup pack

getPackageExtensionId

public String getPackageExtensionId()

Returns:

the id of the extension the XAR contains

setPackageExtensionId

public void setPackageExtensionId(String packageExtensionId)

Parameters:

packageExtensionId - the id of the extension the XAR contains