SitemapContext (Ametys 4.3.x - API)

java.lang.Object
- org.ametys.web.frontoffice.search.instance.model.SitemapContext

public class SitemapContext
extends Object

A sitemap context

Field Summary

Fields
Modifier and Type Field Description

private List<String> _pageIds

private AmetysObjectResolver _resolver

private SitemapContextType _type

Constructor Summary

Constructors
Constructor Description

SitemapContext(SitemapContextType type, List<String> pages, AmetysObjectResolver resolver)
Creates a SitemapContext

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`equals(Object obj)`
`Optional<List<Page>>`	`getPages()`	Gets the pages of the context.
`SitemapContextType`	`getType()`	Gets the type
`int`	`hashCode()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - _type
```
private SitemapContextType _type
```
  - _pageIds
```
private List<String> _pageIds
```
  - _resolver
```
private AmetysObjectResolver _resolver
```
- Constructor Detail
  - SitemapContext
```
public SitemapContext(SitemapContextType type,
                      List<String> pages,
                      AmetysObjectResolver resolver)
```
    Creates a SitemapContext
    
    Parameters:
    
    type - the type
    
    pages - the pages of the context. Must be non-null if type is SitemapContextType.CHILD_PAGES_OF or SitemapContextType.DIRECT_CHILD_PAGES_OF, must be null otherwise.
    
    resolver - The ametys object resolver
- Method Detail
  - getType
```
public SitemapContextType getType()
```
    Gets the type
    
    Returns:
    
    the type
  - getPages
```
public Optional<List<Page>> getPages()
```
    Gets the pages of the context. Must be non-empty if getType() returns SitemapContextType.CHILD_PAGES_OF or SitemapContextType.DIRECT_CHILD_PAGES_OF, must be empty otherwise.
    
    Returns:
    
    the pages of the context
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object