io.neba.core.util

Class ResourceTypeHierarchyIterator

java.lang.Object

io.neba.core.util.ResourceTypeHierarchyIterator

All Implemented Interfaces:

Iterable<String>, Iterator<String>

public class ResourceTypeHierarchyIterator
extends Object
implements Iterator<String>, Iterable<String>

Iterates the type hierarchy of a Resource starting with the resource's "sling:resourceType". next() will either yield the current resource supertype or, if this supertype does not exist, the resource supertype of the resource identified by the current resource type.
Note that this iterator can be empty. Resource.getResourceType() falls back to the primary node type if no "sling:resourceType" property is set; however the node type hierarchy is covered by the NodeTypeHierarchyIterator and is not used by this iterator.

Author:

Olaf Otto

See Also:

ResourceUtil.findResourceSuperType(Resource)

Constructor Summary

Constructors

Constructor and Description
ResourceTypeHierarchyIterator(org.apache.sling.api.resource.Resource resource, org.apache.sling.api.resource.ResourceResolver resourceResolver)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	hasNext()
boolean	isProvideSyntheticResourceRoot() This iterator provides a virtual resource type root common to all synthetic resources to enable mapping to all resources including synthetic ones.
Iterator<String>	iterator()
String	next()
void	remove()
static ResourceTypeHierarchyIterator	typeHierarchyOf(org.apache.sling.api.resource.Resource resource, org.apache.sling.api.resource.ResourceResolver resourceResolver)

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceTypeHierarchyIterator

public ResourceTypeHierarchyIterator(org.apache.sling.api.resource.Resource resource,
                             org.apache.sling.api.resource.ResourceResolver resourceResolver)

Parameters:

resource - must not be null.

Method Detail

typeHierarchyOf

public static ResourceTypeHierarchyIterator typeHierarchyOf(org.apache.sling.api.resource.Resource resource,
                                            org.apache.sling.api.resource.ResourceResolver resourceResolver)

Parameters:

resource - must not be null.

Returns:

never null.

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator<String>

next

public String next()

Specified by:

next in interface Iterator<String>

isProvideSyntheticResourceRoot

public boolean isProvideSyntheticResourceRoot()

This iterator provides a virtual resource type root common to all synthetic resources to enable mapping to all resources including synthetic ones.

See Also:

Constants.SYNTHETIC_RESOURCETYPE_ROOT

remove

public void remove()

Specified by:

remove in interface Iterator<String>

iterator

public Iterator<String> iterator()

Specified by:

iterator in interface Iterable<String>