org.xwiki.vfs

Class VfsResourceReference

java.lang.Object

org.xwiki.resource.AbstractResourceReference

org.xwiki.vfs.VfsResourceReference

All Implemented Interfaces:

ResourceReference

public class VfsResourceReference
extends AbstractResourceReference

Represents a reference to a VFS resource.

Since:

7.4M2

Version:

$Id: 660bf426bd3a680e51886860cb511e2f69224db7 $

Field Summary

Fields

Modifier and Type	Field and Description
static ResourceType	TYPE Represents a VFS Resource Type.

Constructor Summary

Constructors

Constructor and Description
VfsResourceReference(URI fullURI)
VfsResourceReference(URI uri, List<String> pathSegments)
VfsResourceReference(URI uri, String pathSegments)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object object)
String	getPath()
List<String>	getPathSegments()
URI	getURI()
int	hashCode()
String	toString()
URI	toURI()

Methods inherited from class org.xwiki.resource.AbstractResourceReference

addParameter, getParameters, getParameterValue, getParameterValues, getType, setType

Methods inherited from class java.lang.Object

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

Field Detail

TYPE

public static final ResourceType TYPE

Represents a VFS Resource Type.

Constructor Detail

VfsResourceReference

public VfsResourceReference(URI uri,
                            List<String> pathSegments)

Parameters:

uri - the URI pointing to the archive (without the path inside the archive), e.g. attach:space.page@attachment

pathSegments - see getPathSegments()

VfsResourceReference

public VfsResourceReference(URI uri,
                            String pathSegments)

Parameters:

uri - the URI pointing to the archive (without the path inside the archive), e.g. attach:space.page@attachment

pathSegments - see getPathSegments(), specified as "/"-separated string (e.g. "path/to/file")

VfsResourceReference

public VfsResourceReference(URI fullURI)

Parameters:

fullURI - the full opaque URI containing both the reference to the archive and the path to the entry inside it, e.g. attach:space.page@attachment/path/to/file. Note that this constructor requires that any "/" character inside the reference to the archive be URL-encoded

Method Detail

getURI

public URI getURI()

Returns:

the URI to the VFS (e.g. attach:space.page@file.zip, http://server/path/to/zip)

getPathSegments

public List<String> getPathSegments()

Returns:

the list of segments pointing to the relative location of a resource in the VFS (e.g. {"some", "directory", "file.txt"} for some/directory/file.txt

getPath

public String getPath()

Returns:

the String representation with "/" separating each VFS path segment, e.g. some/directory/file.txt

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractResourceReference

equals

public boolean equals(Object object)

Overrides:

equals in class AbstractResourceReference

toString

public String toString()

Overrides:

toString in class AbstractResourceReference

toURI

public URI toURI()

Returns:

the resource reference as a URI