Interface HstSiteMap
- All Known Subinterfaces:
InternalHstSiteMap
public interface HstSiteMap
A
HstSiteMap
contains a list of (root) HstSiteMapItem
objects which themselves might contain additional
HstSiteMapItem
children and so on. As a HstSiteMapItem
might have an id, which needs to be unique
within the HstSiteMap
, through which a direct lookup of such a HstSiteMapItem
is also possible
NOTE: As HstComponent
instances can access HstSiteMap
instances but should not be able to modify them,
implementations must make sure that through the api a HstSiteMap
instance cannot be changed. Returned List and Map
should be therefor unmodifiable.-
Method Summary
Modifier and TypeMethodDescriptiongetSite()
Return theHstSite
thisHstSiteMap
belongs to.getSiteMapItem
(String value) Return the childHstSiteMapItem
that has the correspondingvalue
(HstSiteMapItem.getValue()
) andnull
otherwiseReturn the childHstSiteMapItem
that has the correspondingid
(HstSiteMapItem.getId()
) andnull
otherwisegetSiteMapItemByRefId
(String refId) Return the childHstSiteMapItem
that has the correspondingrefId
(HstSiteMapItem.getRefId()
) andnull
otherwiseThe list ofSiteMapItem
's that areroot
items.
-
Method Details
-
getSite
HstSite getSite()Return theHstSite
thisHstSiteMap
belongs to.- Returns:
- the site this
HstSiteMap
belongs to
-
getSiteMapItems
List<HstSiteMapItem> getSiteMapItems()The list ofSiteMapItem
's that areroot
items. They represent the first paths of the urls. Implementations should return an unmodifiable list, for example the one returned byCollections.unmodifiableList(List)
to avoid client code changing configuration- Returns:
- a List of all root
SiteMapItem
's
-
getSiteMapItem
Return the childHstSiteMapItem
that has the correspondingvalue
(HstSiteMapItem.getValue()
) andnull
otherwise- Parameters:
value
- the value of the childHstSiteMapItem
as it would be returned byHstSiteMapItem.getValue()
- Returns:
- Returns the HstSiteMapItem object corresponding to the unique
value
andnull
if noHstSiteMapItem
exists with thisvalue
in thisHstSiteMapItem
object.
-
getSiteMapItemById
Return the childHstSiteMapItem
that has the correspondingid
(HstSiteMapItem.getId()
) andnull
otherwise- Parameters:
id
- the id of the childHstSiteMapItem
as it would be return byHstSiteMapItem.getId()
- Returns:
- Returns the HstSiteMapItem object corresponding to the unique
id
andnull
if noHstSiteMapItem
exists with thisrefId
in thisHstSiteMapItem
object.
-
getSiteMapItemByRefId
Return the childHstSiteMapItem
that has the correspondingrefId
(HstSiteMapItem.getRefId()
) andnull
otherwise- Parameters:
refId
- the refId of the childHstSiteMapItem
as it would be return byHstSiteMapItem.getRefId()
- Returns:
- Returns the HstSiteMapItem object corresponding to the unique
refId
andnull
if noHstSiteMapItem
exists with thisrefId
in thisHstSiteMapItem
object.
-