org.apache.sling.resource.collection.impl

Class ResourceCollectionManagerImpl

java.lang.Object

org.apache.sling.resource.collection.impl.ResourceCollectionManagerImpl

All Implemented Interfaces:

ResourceCollectionManager

public class ResourceCollectionManagerImpl
extends Object
implements ResourceCollectionManager

Implements ResourceCollectionManger interface. And provides create, delete, get apis for ResourceCollection. This service can be retrieved by looking it up from the service registry or by adapting a ResourceResolver.

Constructor Summary

Constructors

Constructor and Description
ResourceCollectionManagerImpl()

Method Summary

Modifier and Type	Method and Description
ResourceCollection	createCollection(org.apache.sling.api.resource.Resource parentResource, String name) This method creates a resource collection with a given name under the parentResource.
ResourceCollection	createCollection(org.apache.sling.api.resource.Resource parentResource, String name, Map<String,Object> properties) This method creates a resource collection with a given name under the parentResource.
boolean	deleteCollection(org.apache.sling.api.resource.Resource resource) Removes the ResourceCollection corresponding to the collection represented by resource.
ResourceCollection	getCollection(org.apache.sling.api.resource.Resource resource) This method returns a resource collection for the given resource that represents a ResourceCollection.

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceCollectionManagerImpl

public ResourceCollectionManagerImpl()

Method Detail

getCollection

public ResourceCollection getCollection(org.apache.sling.api.resource.Resource resource)

This method returns a resource collection for the given resource that represents a ResourceCollection. It returns null if given resource is not a collection

Specified by:

getCollection in interface ResourceCollectionManager

Parameters:

resource - resource that represents a collection

Returns:

The ResourceCollection representing the collection.

createCollection

public ResourceCollection createCollection(org.apache.sling.api.resource.Resource parentResource,
                                           String name)
                                    throws org.apache.sling.api.resource.PersistenceException

This method creates a resource collection with a given name under the parentResource. The changes are transient and have to be saved by resourceResolver.commit()

Specified by:

createCollection in interface ResourceCollectionManager

Parameters:

parentResource - parent resource where collection needs to be created.

name - The name for collection.

Returns:

The ResourceCollection representing the created collection.

Throws:

org.apache.sling.api.resource.PersistenceException

createCollection

public ResourceCollection createCollection(org.apache.sling.api.resource.Resource parentResource,
                                           String name,
                                           Map<String,Object> properties)
                                    throws org.apache.sling.api.resource.PersistenceException

This method creates a resource collection with a given name under the parentResource. The changes are transient and have to be saved by resourceResolver.commit()

Specified by:

createCollection in interface ResourceCollectionManager

Parameters:

parentResource - parent resource where collection needs to be created.

name - The name for collection.

properties - The additional data for resource collection

Returns:

The ResourceCollection representing the created collection.

Throws:

org.apache.sling.api.resource.PersistenceException

deleteCollection

public boolean deleteCollection(org.apache.sling.api.resource.Resource resource)
                         throws org.apache.sling.api.resource.PersistenceException

Removes the ResourceCollection corresponding to the collection represented by resource. The changes are transient and have to be saved by resourceResolver.commit()

Specified by:

deleteCollection in interface ResourceCollectionManager

Parameters:

resource - resource representing a collection to be deleted.

Returns:

true if the collection was successfully removed.

Throws:

org.apache.sling.api.resource.PersistenceException