org.xwiki.xar

Class XarEntry

java.lang.Object

org.xwiki.model.reference.EntityReference

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: ec6bf30243ca59cce09b2c5d89cc09eb904879c6 $

See Also:

Serialized Form

Field Summary

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

TOSTRING_SERIALIZER

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
int	getDefaultAction()
String	getDocumentName()
String	getEntryName()
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

getLocale, setLocale

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

appendParent, compareTo, equals, equals, equals, equalsNonRecursive, extractFirstReference, extractReference, getName, getParameter, getParent, getReversedReferenceChain, getRoot, getType, hashCode, hasParent, removeParent, replaceParent, setName, setParameter, 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,
        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,
        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

Method Detail

getEntryName

public String getEntryName()

Returns:

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

getDefaultAction

public int getDefaultAction()

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

getDocumentName

public String getDocumentName()

Returns:

the name of the document

toString

public String toString()

Overrides:

toString in class EntityReference