Package org.apache.sling.sitemap.builder
Interface Sitemap
-
@ProviderType public interface Sitemap
A builder-like object that allows to add locations. For each added location anUrl
object is returned which again allows to add more details to the added location.Implementations may build an in-memory data structure when
addUrl(String)
is called, or write each location on an underlying stream immediately.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description @NotNull Url
addUrl(@NotNull java.lang.String location)
Adds a location to theSitemap
.
-
-
-
Method Detail
-
addUrl
@NotNull @NotNull Url addUrl(@NotNull @NotNull java.lang.String location) throws SitemapException
Adds a location to theSitemap
. The returnedUrl
can be used to add more details to the so created object.- Parameters:
location
- the required location of the entry to add.- Returns:
- an
Url
object giving access to the location's details - Throws:
SitemapException
- if any internal operation of the Sitemap fails
-
-