info.magnolia.resourceloader.classpath.service

Interface ClasspathService

All Known Subinterfaces:

MonitoredClasspathService

All Known Implementing Classes:

ClasspathServiceBase, DevelopmentModeClasspathService, LegacyClasspathService, ProductionModeClasspathService

public interface ClasspathService

Organises classpath resources into a hierarchical structure based on ClasspathEntry objects and provides convenient access to it.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ClasspathService.ClasspathEntryNotFoundException Thrown when an attempt to resolve a ClasspathEntry by a path fails.

Method Summary

Methods

Modifier and Type	Method and Description
ClasspathServiceConfiguration	getConfiguration() Get configuration of the current service.
ClasspathEntry	getEntryAt(String path) Get classpath entry corresponding to a given path.
ClasspathDirectory	getParent(ClasspathEntry classpathEntry) Get parent directory of a classpath entry.
ClasspathDirectory	getRoot() Get the root directory of the current service classpath hierarchy structure.
boolean	hasEntry(String path) Check whether current service classpath structure contains an entry which corresponds to a given path.

Method Detail

getConfiguration

ClasspathServiceConfiguration getConfiguration()

Get configuration of the current service.

getRoot

ClasspathDirectory getRoot()

Get the root directory of the current service classpath hierarchy structure. Its path normally equals to /.

Returns:

root classpath directory

getParent

ClasspathDirectory getParent(ClasspathEntry classpathEntry)

Get parent directory of a classpath entry.

getEntryAt

ClasspathEntry getEntryAt(String path)

Get classpath entry corresponding to a given path.

Parameters:

path - absolute path of a classpath entry

Returns:

resolved ClasspathEntry object

hasEntry

boolean hasEntry(String path)

Check whether current service classpath structure contains an entry which corresponds to a given path.