com.adobe.cq.social.scf.core.resourcetree

Class ResourceTypeTree<T>

java.lang.Object

com.adobe.cq.social.scf.core.resourcetree.ResourceTypeTree<T>

Type Parameters:

T - - the type of value being stored/associated with each resource type entry added to the tree.

public class ResourceTypeTree<T>
extends Object

A class that exposes a data structure that can be used to manage entries keyed by a resource type in a resource type hierarchy. This makes it possible to search for values based on the hierarchy, and retrieve results based on super type links when a particular resource type does not have an entry.

Constructor Summary

Constructors

Constructor and Description
ResourceTypeTree(ResourceResolver adminResolver)

Method Summary

Modifier and Type	Method and Description
void	clear() Clears the resource type hierarchy that has been built.
boolean	contains(String resourceType)
T	get(String resourceType) Gets the specific value added for a given specific resource type.
List<Map.Entry<String,T>>	getChildren(String resourceType) Retrieves a list of all the children entries for a resource type based on the resource type hierarchy.
T	getClosest(String resourceType) Gets the most closest matched value for a given resource type.
Collection<Map.Entry<String,T>>	getParents(String resourceType) Retrieves a list of all the parent entries for a resource type based on the resource type hierarchy.
void	put(String resourceType, T value) Adds the given resource type and value to the resource type trees.
void	remove(String resourceType) Removes the given resource type (if present) from the resource type trees built up.
void	setAdminResolver(ResourceResolver adminResolver)

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceTypeTree

public ResourceTypeTree(ResourceResolver adminResolver)

Parameters:

adminResolver - an instance of the ResourceResolver with administrative privileges that will be used to compare resource types.

Method Detail

setAdminResolver

public void setAdminResolver(ResourceResolver adminResolver)

Parameters:

adminResolver - an instance of the ResourceResolver with administrative privileges that will be used to compare resource types.

contains

public boolean contains(String resourceType)

Parameters:

resourceType - the resource type to search for.

Returns:

true if the specific resource type is present, false otherwise. Does not search up or down the tree.

put

public void put(String resourceType,
                T value)

Adds the given resource type and value to the resource type trees. Replaces the entry if an entry already exists for the given resource type.

Parameters:

resourceType - resource type to add.

value - value to associate with the resource type.

remove

public void remove(String resourceType)

Removes the given resource type (if present) from the resource type trees built up.

Parameters:

resourceType - resource type to remove.

getClosest

public T getClosest(String resourceType)

Gets the most closest matched value for a given resource type. If the specific resource type is not found, searches up the resource type hierarchy to find the closest parent for the resource type.

Parameters:

resourceType - resource type to search for

Returns:

the value of the resource type if added. The value of the closest parent if the resource type is not found. Returns null if no parent of the resource type is found.

get

public T get(String resourceType)

Gets the specific value added for a given specific resource type. Does not search the heirarchy chain.

Parameters:

resourceType - the resource type to search for.

Returns:

the value added for the given resource type if found, null if the resource type was not found.

getChildren

public List<Map.Entry<String,T>> getChildren(String resourceType)

Retrieves a list of all the children entries for a resource type based on the resource type hierarchy. Not yet implemented.

Parameters:

resourceType - the resource type for which parents will be found.

Returns:

a list of entries listing each child in the hierarchy for the given resource type.

getParents

public Collection<Map.Entry<String,T>> getParents(String resourceType)

Retrieves a list of all the parent entries for a resource type based on the resource type hierarchy.

Parameters:

resourceType - the resource type for which parents will be found.

Returns:

a list of entries listing each parent in the hierarchy for the given resource type.

clear

public void clear()

Clears the resource type hierarchy that has been built.