public interface PathLookup
lookup
predefined paths for nodes. These paths are defined
using URLProperties
and can be requested
using SiteStoreFolder.getStoredUrl(Language, TemplateSet)
and MediaFolder.getStoredUrl(Language)
.
The default implementation is available via the INSTANCE
field. This is also the instance which is
provided to UrlFactory.setUp(UrlFactoryContext)
from UrlFactoryContext.getPathLookup()
.INSTANCE
Modifier and Type | Field and Description |
---|---|
static PathLookup |
INSTANCE
The default implementation.
|
Modifier and Type | Method and Description |
---|---|
String |
lookupPath(IDProvider folder,
Language language,
TemplateSet templateSet)
Get the predefined path for the requested folder node or
null , if no predefined path is set. |
static final PathLookup INSTANCE
@Nullable String lookupPath(@NotNull IDProvider folder, @NotNull Language language, @Nullable TemplateSet templateSet)
null
, if no predefined path is set. Even if
null
is returned there may be a parent folder where this method will return not
null
. For root nodes this method returns the empty string when no path is stored.
For non-folder nodes the return value will always be null
.
folder
- Folder node to look up.language
- Language for lookup.templateSet
- Template-set for lookup, could be null
if folder
is from
media store
.null
if no path is set or the empty string for
store root nodes when no path is stored.NullPointerException
- if the provided folder or language is null or a sitestore folder is provided but no
template set.Copyright © 2021 e-Spirit AG. All Rights Reserved. Build 5.2.210210