org.apache.sling.api.resource
Class ResourceUtil

java.lang.Object
  org.apache.sling.api.resource.ResourceUtil

public class ResourceUtil
extends java.lang.Object

The ResourceUtil class provides helper methods dealing with resources.

Constructor Summary

ResourceUtil()

Method Summary

static java.lang.String	getName(Resource rsrc) Utility method returns the parent resource of the resource.
static java.lang.String	getName(java.lang.String path) Utility method returns the name of the given path, which is normalized by normalize(String) before resolving the name.
static Resource	getParent(Resource rsrc) Utility method returns the parent resource of the resource.
static java.lang.String	getParent(java.lang.String path) Utility method returns the parent path of the given path, which is normalized by normalize(String) before resolving the parent.
static ValueMap	getValueMap(Resource res) Returns an ValueMap object for the given Resource.
static boolean	isNonExistingResource(Resource res) Returns true if the resource res is a non-existing resource.
static boolean	isStarResource(Resource res) Returns true if the resource res is a "star resource".
static boolean	isSyntheticResource(Resource res) Returns true if the resource res is a synthetic resource.
static java.util.Iterator<Resource>	listChildren(Resource parent) Returns an Iterator of Resource objects loaded from the children of the given Resource.
static java.lang.String	normalize(java.lang.String path) Resolves relative path segments '.' and '..' in the absolute path.

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceUtil

public ResourceUtil()

Method Detail

normalize

public static java.lang.String normalize(java.lang.String path)

Resolves relative path segments '.' and '..' in the absolute path. Returns null if not possible (.. points above root) or if path is not absolute.

getParent

public static java.lang.String getParent(java.lang.String path)

Utility method returns the parent path of the given path, which is normalized by normalize(String) before resolving the parent.

Parameters:

path - The path whose parent is to be returned.

Returns:

null if path is the root path (/) or if path is a single name containing no slash (/) characters.

Throws:

java.lang.IllegalArgumentException - If the path cannot be normalized by the normalize(String) method.

java.lang.NullPointerException - If path is null.

getParent

public static Resource getParent(Resource rsrc)

Utility method returns the parent resource of the resource.

Returns:

The parent resource or null if the rsrc is the root.

Throws:

java.lang.NullPointerException - If rsrc is null.

getName

public static java.lang.String getName(Resource rsrc)

Utility method returns the parent resource of the resource.

Throws:

java.lang.NullPointerException - If rsrc is null.

getName

public static java.lang.String getName(java.lang.String path)

Utility method returns the name of the given path, which is normalized by normalize(String) before resolving the name.

Parameters:

path - The path whose name (the last path element) is to be returned.

Returns:

The empty string if path is the root path (/) or if path is a single name containing no slash (/) characters.

Throws:

java.lang.IllegalArgumentException - If the path cannot be normalized by the normalize(String) method.

java.lang.NullPointerException - If path is null.

isSyntheticResource

public static boolean isSyntheticResource(Resource res)

Returns true if the resource res is a synthetic resource.

This method checks whether the resource is an instance of the org.apache.sling.resource.SyntheticResource class.

Parameters:

res - The Resource to check whether it is a synthetic resource.

Returns:

true if res is a synthetic resource. false is returned if res is null or not an instance of the org.apache.sling.resource.SyntheticResource class.

isStarResource

public static boolean isStarResource(Resource res)

Returns true if the resource res is a "star resource". A star resource is a resource returned from the ResourceResolver.resolve(HttpServletRequest) whose path terminates in a /*. Generally such resource result from requests to something like /some/path/* or /some/path/*.html which may be used web applications to uniformly handle resources to be created.

This method checks whether the resource path ends with a /* indicating such a star resource.

Parameters:

res - The Resource to check whether it is a star resource.

Returns:

true if res is to be considered a star resource.

Throws:

java.lang.NullPointerException - if res is null.

isNonExistingResource

public static boolean isNonExistingResource(Resource res)

Returns true if the resource res is a non-existing resource.

This method checks the resource type of the resource to match the well-known resource type sling:nonexisting of the NonExistingResource class defined in the Sling API.

Parameters:

res - The Resource to check whether it is a non-existing resource.

Returns:

true if res is to be considered a non-existing resource.

Throws:

java.lang.NullPointerException - if res is null.

listChildren

public static java.util.Iterator<Resource> listChildren(Resource parent)

Returns an Iterator of Resource objects loaded from the children of the given Resource.

This is a convenience method for ResourceResolver.listChildren(Resource).

Parameters:

parent - The Resource whose children are requested.

Returns:

An Iterator of Resource objects.

Throws:

java.lang.NullPointerException - If parent is null.

SlingException - If any error occurs acquiring the child resource iterator.

See Also:

ResourceResolver.listChildren(Resource)

getValueMap

public static ValueMap getValueMap(Resource res)

Returns an ValueMap object for the given Resource. This method calls Adaptable.adaptTo(Class) with the ValueMap class as an argument. If the adaptTo method returns a map, this map is returned. If the resource is not adaptable to a value map, next an adaption to Map is tried and if this is successful the map is wrapped as a value map. If the adaptions are not successful an empty value map is returned. If null is provided as the resource an empty map is returned as well.

Parameters:

res - The Resource to adapt to the value map.

Returns:

A value map.