com.day.cq.contentbus

Class DefaultPathContext

java.lang.Object

com.day.cq.contentbus.AbstractPathContext

com.day.cq.contentbus.DefaultPathContext

All Implemented Interfaces:

PathContext

public class DefaultPathContext
extends AbstractPathContext

The DefaultPathContext is an implementation of the PathContext iterface. The set of paths is modified by the add(), insert() and remove() methods. There is a destinction of 2 kind of paths, when adding them. there are root-paths, which are always absolute and there are subpaths, which are always relative. The complete set of paths is a combination of the root and the sub paths in a way, that ever subpath is combined with every root path.

example:

ctx.insert("/libs"); ctx.insert("/apps"); ctx.insert("global"); ctx.insert("main"); would result the following path-enumeration: [0] "/apps/main/" [1] "/libs/main/" [2] "/apps/global/" [3] "/libs/global/" [4] "/apps/" [5] "/libs/"

Since:

coati

Constructor Summary

Constructors

Constructor and Description
DefaultPathContext()

Method Summary

Methods

Modifier and Type	Method and Description
void	add(java.lang.String path) Adds a new path.
protected java.util.ArrayList	buildPathCache(Ticket ticket) Builds the cache of path elements.
void	clear() Clears all path information
void	insert(java.lang.String path) Inserts a new path.
void	remove(java.lang.String path) Removes a path either from the root path or the sub path list.

Methods inherited from class com.day.cq.contentbus.AbstractPathContext

acceptHandle, expandPath, needCacheBuild, paths, paths, resolveHandle, setNeedCacheBuild

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultPathContext

public DefaultPathContext()

Method Detail

add

public void add(java.lang.String path)

Adds a new path. If the path is relative, the path is added at the end of the list of sub paths, otherwise its added at the end of the list of root paths.

Parameters:

path - the path to add

insert

public void insert(java.lang.String path)

Inserts a new path. If the path is relative, the path is inserted at the beginning of the list of sub paths, otherwise its inserted at the beginning of the list of root paths.

Parameters:

path - the path to insert

remove

public void remove(java.lang.String path)

Removes a path either from the root path or the sub path list.

Parameters:

path - path to remove

clear

public void clear()

Clears all path information

buildPathCache

protected java.util.ArrayList buildPathCache(Ticket ticket)

Builds the cache of path elements. This method does not need to expand any glob patterns which might be contained in the resulting path cache.

This method is called from the AbstractPathContext.buildExpandedPathCache(com.day.cq.contentbus.Ticket) method, which after building the base path cache cares to expand any globs which might be contained in any handle within the path cache.

Specified by:

buildPathCache in class AbstractPathContext

Parameters:

ticket - The Ticket might be used to access the ContentBus.

Returns:

An ArrayList containing the path elements, which might still contain glob patterns.