org.apache.sling.resource.collection.impl

Class ResourceCollectionImpl

java.lang.Object

org.apache.sling.resource.collection.impl.ResourceCollectionImpl

All Implemented Interfaces:

ResourceCollection

public class ResourceCollectionImpl
extends Object
implements ResourceCollection

Implements ResourceCollection

Constructor Summary

Constructors

Constructor and Description
ResourceCollectionImpl(org.apache.sling.api.resource.Resource resource) Creates a new collection from the given resource

Method Summary

Modifier and Type	Method and Description
boolean	add(org.apache.sling.api.resource.Resource res) Creates a new entry in the collection at the last position and add a reference to resource in the entry.
boolean	add(org.apache.sling.api.resource.Resource res, Map<String,Object> properties) Creates a new entry in the collection at the last position and add a reference to resource in the entry.
boolean	contains(org.apache.sling.api.resource.Resource res) Returns true if resource reference is part of the collection.
String	getName() Returns name of the collection.
String	getPath() Returns path of the collection.
org.apache.sling.api.resource.ModifiableValueMap	getProperties(org.apache.sling.api.resource.Resource resource) Returns additional properties for a particular resource in Collection entry.
Iterator<org.apache.sling.api.resource.Resource>	getResources() Returns an iterator over resources referred in the collection in the specified order.
String	getType() Returns the sling resource type on content node of collection
void	orderBefore(org.apache.sling.api.resource.Resource srcResource, org.apache.sling.api.resource.Resource destResource) This method inserts the referenced resource srcResource into the collection entry at the position immediately before the referenced resource destResource.
boolean	remove(org.apache.sling.api.resource.Resource res) Removes a entry of resource from collection & returns true if successful.
void	setType(String type) Sets the sling resource type on content node of collection

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceCollectionImpl

public ResourceCollectionImpl(org.apache.sling.api.resource.Resource resource)

Creates a new collection from the given resource

Parameters:

resource - the resource

Method Detail

getName

public String getName()

Returns name of the collection.

Specified by:

getName in interface ResourceCollection

Returns:

name of the collection.

getPath

public String getPath()

Returns path of the collection.

Specified by:

getPath in interface ResourceCollection

Returns:

path of the collection.

add

public boolean add(org.apache.sling.api.resource.Resource res,
                   Map<String,Object> properties)
            throws org.apache.sling.api.resource.PersistenceException

Creates a new entry in the collection at the last position and add a reference to resource in the entry. Changes are transient & have to be saved by calling resolver.commit()

Specified by:

add in interface ResourceCollection

Parameters:

res - resource to be added

properties - The additional properties to be stored with the collection entry (can be null).

Returns:

true if addition of resource to collection was successful or false if collection already contained the resource or resource is null.

Throws:

org.apache.sling.api.resource.PersistenceException

add

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

Creates a new entry in the collection at the last position and add a reference to resource in the entry. Changes are transient & have to be saved by calling resolver.commit()

Specified by:

add in interface ResourceCollection

Parameters:

res - resource to be added

Returns:

true if addition of resource to collection was successful or false if collection already contained the resource or resource is null.

Throws:

org.apache.sling.api.resource.PersistenceException

getResources

public Iterator<org.apache.sling.api.resource.Resource> getResources()

Returns an iterator over resources referred in the collection in the specified order.

Specified by:

getResources in interface ResourceCollection

Returns:

iterator over resources referred in collection.

getType

public String getType()

Returns the sling resource type on content node of collection

Parameters:

-

Returns:

sling:resourceType for the collection resource

contains

public boolean contains(org.apache.sling.api.resource.Resource res)

Returns true if resource reference is part of the collection.

Specified by:

contains in interface ResourceCollection

Parameters:

res - resource to be checked

Returns:

true if resource is part of the collection. false otherwise

remove

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

Removes a entry of resource from collection & returns true if successful. Changes are transient & have to be saved by calling resolver.commit()

Specified by:

remove in interface ResourceCollection

Parameters:

res - resource reference to be removed

Returns:

true if resource reference was successfully removed from the collection. false if not removed/not present

Throws:

org.apache.sling.api.resource.PersistenceException

setType

public void setType(String type)
             throws org.apache.sling.api.resource.PersistenceException

Sets the sling resource type on content node of collection

Parameters:

type - sling:resourceType to be set on the content node

Throws:

org.apache.sling.api.resource.PersistenceException

orderBefore

public void orderBefore(org.apache.sling.api.resource.Resource srcResource,
                        org.apache.sling.api.resource.Resource destResource)

Description copied from interface: ResourceCollection

This method inserts the referenced resource srcResource into the collection entry at the position immediately before the referenced resource destResource. To insert the referenced resource into last position, destResource can be null.

Specified by:

orderBefore in interface ResourceCollection

Parameters:

srcResource - Referenced resource that needs to be moved in the order

destResource - Referenced resource before which the srcResource will be placed.

getProperties

public org.apache.sling.api.resource.ModifiableValueMap getProperties(org.apache.sling.api.resource.Resource resource)

Description copied from interface: ResourceCollection

Returns additional properties for a particular resource in Collection entry.

Specified by:

getProperties in interface ResourceCollection

Returns:

properties of the Collection entry as ModifiableValueMap, returns null if entry found.