de.espirit.firstspirit.generate

Interface PathLookup

public interface PathLookup

With a path lookup you could lookup predefined pathes for nodes. These pathes may be defined using URLProperties.

Since:

5.0.17

Method Summary

Methods

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.

Method Detail

lookupPath

@Nullable
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. 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.
The returned path never ends with "/". The returned path starts with a "/" if the path is not full qualified (i.e. starts with "http://" or "https://").

Parameters:

folder - Folder node to look up.

language - Language for lookup.

templateSet - Template-set for lookup.

Returns:

The predefined path for the requested node or null if no path is set or the empty string for store root nodes when no path is stored.

Since:

5.0.17