lumis.portal.deployment.resource

Class ResourceEnumerator

java.lang.Object

lumis.portal.deployment.resource.ResourceEnumerator

public abstract class ResourceEnumerator
extends Object

Resource enumerator that holds the base path to be used in path relativizations.

Since:

8.0.0

Version:

$Revision: 17182 $ $Date: 2015-03-30 19:00:24 +0000 (Mon, 30 Mar 2015) $

Constructor Summary

Constructors

Constructor and Description
ResourceEnumerator(URI basePath) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
URI	getBasePath() Returns the base path to be used in path relativizations.
abstract Set<String>	listResources(boolean recursively) Lists the available resources within the given basePath. If the given base path does not exists, an empty set is returned.

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceEnumerator

public ResourceEnumerator(URI basePath)

Creates a new instance.

Parameters:

basePath - the base path to be used in path relativizations.

Since:

8.0.0

Method Detail

getBasePath

public URI getBasePath()

Returns the base path to be used in path relativizations.

Returns:

the base path to be used in path relativizations.

Since:

8.0.0

listResources

public abstract Set<String> listResources(boolean recursively)

Lists the available resources within the given basePath.
If the given base path does not exists, an empty set is returned.

Parameters:

recursively - indicates whether the resource search should be recursive.

Returns:

the available resources within the given basePath.

Since:

8.0.0