Package org.java.plugin
Interface PathResolver
- All Known Implementing Classes:
ShadingPathResolver
,StandardPathResolver
public interface PathResolver
This interface is intended to establish correspondence between relative path
and absolute URL in context of plug-in or plug-in fragment.
- Version:
- $Id$
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionvoid
configure
(ExtendedProperties config) Configures this resolver instance.Returns URL ofregistered
plug-in element context.boolean
void
registerContext
(Identity idt, URL url) Registers "home" URL for given plug-in element.resolvePath
(Identity identity, String path) Should resolve given path to URL for a given identity.void
Unregisters plug-in element from this path resolver.
-
Method Details
-
configure
Configures this resolver instance. Usually this method is called fromobject factory
implementation.- Parameters:
config
- path resolver configuration data- Throws:
Exception
- if any error has occurred
-
registerContext
Registers "home" URL for given plug-in element.- Parameters:
idt
- plug-in elementurl
- "home" URL for a given plug-in element
-
unregisterContext
Unregisters plug-in element from this path resolver.- Parameters:
id
- plug-in element identifier
-
getRegisteredContext
Returns URL ofregistered
plug-in element context. If context for plug-in element with given ID not registered, this method should throw anIllegalArgumentException
. In other words, this method shouldn't returnnull
.- Parameters:
id
- plug-in element identifier- Returns:
- registered context "home" location
-
isContextRegistered
- Parameters:
id
- plug-in element identifier- Returns:
true
if context for plug-in element with given ID registered
-
resolvePath
Should resolve given path to URL for a given identity.- Parameters:
identity
- plug-in element for which to resolve pathpath
- path to be resolved- Returns:
- resolved absolute URL
-