Package org.xwiki.xar

Class XarEntry

java.lang.Object

org.xwiki.model.reference.EntityReference

org.xwiki.model.reference.AbstractLocalizedEntityReference

org.xwiki.model.reference.LocalDocumentReference

org.xwiki.xar.XarEntry

All Implemented Interfaces:

Serializable, Cloneable, Comparable<EntityReference>

public class XarEntry
extends LocalDocumentReference

An entry (wiki page) in a XAR package.

Reuse LocalDocumentReference equals and hashCode implementation so that the entry can be used as a LocalDocumentReference in a map.

Since:

5.4RC1

Version:

$Id: 86e580c40e6905a69eb9e39eb4e24b106bf211ad $

See Also:

Serialized Form

Field Summary

Fields inherited from class org.xwiki.model.reference.AbstractLocalizedEntityReference

LOCALE

Fields inherited from class org.xwiki.model.reference.EntityReference

TOSTRING_SERIALIZER

Constructor Summary

Constructors

Constructor	Description
XarEntry(LocalDocumentReference reference)
XarEntry(LocalDocumentReference reference, int defaultAction)
XarEntry(LocalDocumentReference reference, int defaultAction, String entryType)
XarEntry(LocalDocumentReference reference, String name)
XarEntry(LocalDocumentReference reference, String name, int defaultAction)
XarEntry(LocalDocumentReference reference, String name, int defaultAction, String entryType)
XarEntry(LocalDocumentReference reference, String name, String entryType)

Method Summary

Modifier and Type	Method	Description
int	getDefaultAction()	Deprecated. kept for retro compatibility reason (since this used to exist in XAR format) but this method never really been used in XWiki Standard.
String	getDocumentName()
String	getEntryName()
String	getEntryType()
String	getSpaceName()	Deprecated. since 7.2M1, does not make much sense anymore with nested space
String	toString()

Methods inherited from class org.xwiki.model.reference.LocalDocumentReference

replaceParent

Methods inherited from class org.xwiki.model.reference.AbstractLocalizedEntityReference

getLocale, setLocale, setParameter

Methods inherited from class org.xwiki.model.reference.EntityReference

appendParent, compareTo, equals, equals, equals, equalsNonRecursive, extractFirstReference, extractReference, getName, getParameter, getParameters, getParent, getReversedReferenceChain, getRoot, getType, hashCode, hasParent, removeParent, replaceParent, setName, setParameters, setParent, setType, size

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

XarEntry

public XarEntry(LocalDocumentReference reference)

Parameters:

reference - the reference of the document

XarEntry

public XarEntry(LocalDocumentReference reference,
                String name)

Parameters:

reference - the reference of the document

name - the name of the entry (ZIP style)

XarEntry

public XarEntry(LocalDocumentReference reference,
                String name,
                String entryType)

Parameters:

reference - the reference of the document

name - the name of the entry (ZIP style)

entryType - the type of the entry

Since:

10.3

XarEntry

public XarEntry(LocalDocumentReference reference,
                int defaultAction)

Parameters:

reference - the reference of the document

defaultAction - the default action associated to a XAR entry

Since:

7.2M1

XarEntry

public XarEntry(LocalDocumentReference reference,
                int defaultAction,
                String entryType)

Parameters:

reference - the reference of the document

defaultAction - the default action associated to a XAR entry

entryType - the type of the entry

Since:

10.3

XarEntry

public XarEntry(LocalDocumentReference reference,
                String name,
                int defaultAction)

Parameters:

reference - the reference of the document

name - the name of the entry (ZIP style)

defaultAction - the default action associated to a XAR entry (not used at the moment)

XarEntry

public XarEntry(LocalDocumentReference reference,
                String name,
                int defaultAction,
                String entryType)

Parameters:

reference - the reference of the document

name - the name of the entry (ZIP style)

defaultAction - the default action associated to a XAR entry (not used at the moment)

entryType - the type of the entry

Since:

10.3

Method Detail

getEntryName

public String getEntryName()

Returns:

the name of the entry in the ZIP (XAR) package

getEntryType

public String getEntryType()

Returns:

the type of the entry

Since:

10.3

getDocumentName

public String getDocumentName()

Returns:

the name of the document

toString

public String toString()

Overrides:

toString in class LocalDocumentReference

getDefaultAction

@Deprecated
public int getDefaultAction()

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 getEntryType().

Returns:

the default action associated to the entry

getSpaceName

@Deprecated
public String getSpaceName()

Deprecated.

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

Returns:

the space of the document