A C D G I O R S T V W X
All Classes All Packages

A

AbstractXarEntryType - Class in org.xwiki.xar.type

Base class helper to implement XarEntryType.

AbstractXarEntryType(String) - Constructor for class org.xwiki.xar.type.AbstractXarEntryType

addEntry(LocalDocumentReference) - Method in class org.xwiki.xar.XarPackage

Deprecated.

since 7.2M1, use XarPackage.addPackageFile(LocalDocumentReference, int) instead

addEntry(LocalDocumentReference, String) - Method in class org.xwiki.xar.XarPackage

Add a new entry to the package.

addEntry(LocalDocumentReference, String, int) - Method in class org.xwiki.xar.XarPackage

Add a new entry to the package.

addPackageFile(LocalDocumentReference, int) - Method in class org.xwiki.xar.XarPackage

Add a new entry to the package.

C

close() - Method in class org.xwiki.xar.XarFile

D

DOCUMENT_PREFIX - Static variable in interface org.xwiki.xar.XarEntryTypeResolver

The prefix used for the hints of components specific to the entry reference.

G

getDefault() - Method in interface org.xwiki.xar.XarEntryTypeResolver

getDefaultAction() - Method in class org.xwiki.xar.XarEntry

Deprecated.

kept for retro compatibility reason (since this used to exist in XAR format) but this method never really been used in XWiki Standard. Similar concept (among other things) are exposed through XarEntry.getEntryType().

getDocumentName() - Method in class org.xwiki.xar.XarEntry

getEntries() - Method in class org.xwiki.xar.XarFile

getEntries() - Method in class org.xwiki.xar.XarPackage

getEntries(File) - Static method in class org.xwiki.xar.XarPackage

Get all entries found in a XAR file.

getEntry(LocalDocumentReference) - Method in class org.xwiki.xar.XarFile

getEntry(LocalDocumentReference) - Method in class org.xwiki.xar.XarPackage

getEntryName() - Method in class org.xwiki.xar.XarEntry

getEntryType() - Method in class org.xwiki.xar.XarEntry

getFile() - Method in class org.xwiki.xar.XarFile

getInputStream(LocalDocumentReference) - Method in class org.xwiki.xar.XarFile

getName() - Method in class org.xwiki.xar.type.AbstractXarEntryType

getName() - Method in interface org.xwiki.xar.XarEntryType

getPackageAuthor() - Method in class org.xwiki.xar.XarPackage

getPackageDescription() - Method in class org.xwiki.xar.XarPackage

getPackageExtensionId() - Method in class org.xwiki.xar.XarPackage

getPackageFiles() - Method in class org.xwiki.xar.XarPackage

getPackageLicense() - Method in class org.xwiki.xar.XarPackage

getPackageName() - Method in class org.xwiki.xar.XarPackage

getPackageVersion() - Method in class org.xwiki.xar.XarPackage

getSpaceName() - Method in class org.xwiki.xar.XarEntry

Deprecated.

since 7.2M1, does not make much sense anymore with nested space

getUpgradeType() - Method in class org.xwiki.xar.type.AbstractXarEntryType

getUpgradeType() - Method in interface org.xwiki.xar.XarEntryType

getXarPackage() - Method in class org.xwiki.xar.XarFile

I

isDeleteAllowed() - Method in class org.xwiki.xar.type.AbstractXarEntryType

isDeleteAllowed() - Method in interface org.xwiki.xar.XarEntryType

isEditAllowed() - Method in class org.xwiki.xar.type.AbstractXarEntryType

isEditAllowed() - Method in interface org.xwiki.xar.XarEntryType

isPackageBackupPack() - Method in class org.xwiki.xar.XarPackage

isPackagePreserveVersion() - Method in class org.xwiki.xar.XarPackage

O

org.xwiki.xar - package org.xwiki.xar

org.xwiki.xar.type - package org.xwiki.xar.type

OVERWRITE - org.xwiki.xar.XarEntryType.UpgradeType

Always overwrite the existing document.

R

read(File) - Method in class org.xwiki.xar.XarPackage

Find and add the entries located in the passed XAR directory.

read(InputStream) - Method in class org.xwiki.xar.XarPackage

Find and add the entries located in the passed XAR file.

read(ZipFile) - Method in class org.xwiki.xar.XarPackage

Find and add the entries located in the passed XAR file.

readDescriptor(InputStream) - Method in class org.xwiki.xar.XarPackage

Read a XML descriptor of a XAR package (usually names package.xml).

resolve(XarEntry, boolean) - Method in interface org.xwiki.xar.XarEntryTypeResolver

S

setDeleteAllowed(boolean) - Method in class org.xwiki.xar.type.AbstractXarEntryType

setEditAllowed(boolean) - Method in class org.xwiki.xar.type.AbstractXarEntryType

setPackageAuthor(String) - Method in class org.xwiki.xar.XarPackage

setPackageBackupPack(boolean) - Method in class org.xwiki.xar.XarPackage

setPackageDescription(String) - Method in class org.xwiki.xar.XarPackage

setPackageExtensionId(String) - Method in class org.xwiki.xar.XarPackage

setPackageLicense(String) - Method in class org.xwiki.xar.XarPackage

setPackageName(String) - Method in class org.xwiki.xar.XarPackage

setPackagePreserveVersion(boolean) - Method in class org.xwiki.xar.XarPackage

setPackageVersion(String) - Method in class org.xwiki.xar.XarPackage

setPreserveVersion(boolean) - Method in class org.xwiki.xar.XarPackage

Deprecated.

since 7.2M1, use XarPackage.setPackagePreserveVersion(boolean) instead

setUpgradeType(XarEntryType.UpgradeType) - Method in class org.xwiki.xar.type.AbstractXarEntryType

SKIP - org.xwiki.xar.XarEntryType.UpgradeType

If what already exists is non standard don't touch it.

SKIP_ALLWAYS - org.xwiki.xar.XarEntryType.UpgradeType

If anything already exists don't touch it.

T

THREEWAYS - org.xwiki.xar.XarEntryType.UpgradeType

Apply a 3 ways merge (the default).

toString() - Method in class org.xwiki.xar.XarEntry

toString() - Method in class org.xwiki.xar.XarFile

V

valueOf(String) - Static method in enum org.xwiki.xar.XarEntryType.UpgradeType

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.xwiki.xar.XarEntryType.UpgradeType

Returns an array containing the constants of this enum type, in the order they are declared.

W

write(OutputStream, String) - Method in class org.xwiki.xar.XarPackage

Write the package descriptor to the passed stream as XML.

write(XMLStreamWriter) - Method in class org.xwiki.xar.XarPackage

Write the package descriptor to the passed XML stream.

write(ZipArchiveOutputStream, String) - Method in class org.xwiki.xar.XarPackage

Write and add the package descriptor to the passed ZIP stream.

X

XarEntry - Class in org.xwiki.xar

An entry (wiki page) in a XAR package.

XarEntry(LocalDocumentReference) - Constructor for class org.xwiki.xar.XarEntry

XarEntry(LocalDocumentReference, int) - Constructor for class org.xwiki.xar.XarEntry

XarEntry(LocalDocumentReference, int, String) - Constructor for class org.xwiki.xar.XarEntry

XarEntry(LocalDocumentReference, String) - Constructor for class org.xwiki.xar.XarEntry

XarEntry(LocalDocumentReference, String, int) - Constructor for class org.xwiki.xar.XarEntry

XarEntry(LocalDocumentReference, String, int, String) - Constructor for class org.xwiki.xar.XarEntry

XarEntry(LocalDocumentReference, String, String) - Constructor for class org.xwiki.xar.XarEntry

XarEntryType - Interface in org.xwiki.xar

The type of the XarEntry which control the behavior to adopt while upgrading, editing, etc.

XarEntryType.UpgradeType - Enum in org.xwiki.xar

The upgrade behavior.

XarEntryTypeResolver - Interface in org.xwiki.xar

Resolve proper XarEntryType instance depending on the name and the context.

XarException - Exception in org.xwiki.xar

XarException(String) - Constructor for exception org.xwiki.xar.XarException

XarException(String, Throwable) - Constructor for exception org.xwiki.xar.XarException

XarException(Throwable) - Constructor for exception org.xwiki.xar.XarException

XarFile - Class in org.xwiki.xar

XarFile(File) - Constructor for class org.xwiki.xar.XarFile

XarFile(File, Collection<XarEntry>) - Constructor for class org.xwiki.xar.XarFile

XarFile(File, XarPackage) - Constructor for class org.xwiki.xar.XarFile

XarPackage - Class in org.xwiki.xar

Manipulate package.xml XAR package file.

XarPackage() - Constructor for class org.xwiki.xar.XarPackage

Default constructor.

XarPackage(File) - Constructor for class org.xwiki.xar.XarPackage

XarPackage(InputStream) - Constructor for class org.xwiki.xar.XarPackage

XarPackage(Collection<XarEntry>) - Constructor for class org.xwiki.xar.XarPackage

XarPackage(ZipFile) - Constructor for class org.xwiki.xar.XarPackage

A C D G I O R S T V W X
All Classes All Packages