Class SitemapGenerator
- java.lang.Object
-
- cz.jiripinkas.jsitemapgenerator.AbstractGenerator
-
- cz.jiripinkas.jsitemapgenerator.AbstractSitemapGenerator
-
- cz.jiripinkas.jsitemapgenerator.generator.SitemapGenerator
-
public class SitemapGenerator extends AbstractSitemapGenerator
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
SitemapGenerator.AdditionalNamespace
-
Field Summary
-
Fields inherited from class cz.jiripinkas.jsitemapgenerator.AbstractSitemapGenerator
dateFormat
-
Fields inherited from class cz.jiripinkas.jsitemapgenerator.AbstractGenerator
baseUrl, urls
-
-
Constructor Summary
Constructors Constructor Description SitemapGenerator(String baseUrl)
Deprecated.Useof(String)
SitemapGenerator(String baseUrl, SitemapGenerator.AdditionalNamespace[] additionalNamespaces)
Deprecated.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description SitemapGenerator
addPage(WebPage webPage)
Add single page to sitemapSitemapGenerator
addPages(Collection<WebPage> webPages)
Add collection of pages to sitemap<T> SitemapGenerator
addPages(Collection<T> webPages, java.util.function.Function<T,WebPage> mapper)
Add collection of pages to sitemapString[]
constructSitemap()
Construct sitemap into array of Strings.SitemapGenerator
defaultChangeFreq(ChangeFreq changeFreq)
Sets default changeFreqSitemapGenerator
defaultChangeFreqAlways()
Sets default changeFreq to ALWAYSSitemapGenerator
defaultChangeFreqDaily()
Sets default changeFreq to DAILYSitemapGenerator
defaultChangeFreqHourly()
Sets default changeFreq to HOURLYSitemapGenerator
defaultChangeFreqMonthly()
Sets default changeFreq to MONTHLYSitemapGenerator
defaultChangeFreqNever()
Sets default changeFreq to NEVERSitemapGenerator
defaultChangeFreqWeekly()
Sets default changeFreq to WEEKLYSitemapGenerator
defaultChangeFreqYearly()
Sets default changeFreq to YEARLYSitemapGenerator
defaultPriorityMax()
Sets default priority to maximum (1.0)SitemapGenerator
dir(String dirName)
Sets default prefix dir to name.SitemapGenerator
dir(String... dirNames)
Sets default prefix dirs to name.SitemapGenerator
extension(String extension)
Sets default suffix extension.static SitemapGenerator
of(String baseUrl)
Helper method to create an instance of SitemapGeneratorstatic SitemapGenerator
of(String baseUrl, SitemapGenerator.AdditionalNamespace[] additionalNamespaces)
Helper method to create an instance of SitemapGeneratorvoid
setDefaultPriority(Double priority)
Sets default priority-
Methods inherited from class cz.jiripinkas.jsitemapgenerator.AbstractSitemapGenerator
constructAndSaveSitemap, constructSitemapGzip, constructSitemapString, escapeXmlSpecialCharacters, pingBing, pingBing, pingGoogle, pingGoogle, saveSitemap
-
-
-
-
Constructor Detail
-
SitemapGenerator
@Deprecated public SitemapGenerator(String baseUrl)
Deprecated.Useof(String)
- Parameters:
baseUrl
- Base URL
-
SitemapGenerator
@Deprecated public SitemapGenerator(String baseUrl, SitemapGenerator.AdditionalNamespace[] additionalNamespaces)
Deprecated.- Parameters:
baseUrl
- Base URLadditionalNamespaces
- Additional parameters
-
-
Method Detail
-
of
public static SitemapGenerator of(String baseUrl)
Helper method to create an instance of SitemapGenerator- Parameters:
baseUrl
- Base URL- Returns:
- Instance of SitemapGenerator
-
of
public static SitemapGenerator of(String baseUrl, SitemapGenerator.AdditionalNamespace[] additionalNamespaces)
Helper method to create an instance of SitemapGenerator- Parameters:
baseUrl
- Base URLadditionalNamespaces
- Additional parameters- Returns:
- Instance of SitemapGenerator
-
constructSitemap
public String[] constructSitemap()
Construct sitemap into array of Strings. The URLs will be ordered using priority in descending order (URLs with higher priority will be at the top).- Specified by:
constructSitemap
in classAbstractSitemapGenerator
- Returns:
- sitemap
-
addPage
public SitemapGenerator addPage(WebPage webPage)
Add single page to sitemap- Overrides:
addPage
in classAbstractGenerator
- Parameters:
webPage
- single page- Returns:
- this
-
addPages
public SitemapGenerator addPages(Collection<WebPage> webPages)
Add collection of pages to sitemap- Overrides:
addPages
in classAbstractGenerator
- Parameters:
webPages
- Collection of pages- Returns:
- this
-
addPages
public <T> SitemapGenerator addPages(Collection<T> webPages, java.util.function.Function<T,WebPage> mapper)
Add collection of pages to sitemap- Overrides:
addPages
in classAbstractGenerator
- Type Parameters:
T
- This is the type parameter- Parameters:
webPages
- Collection of pagesmapper
- Mapper function which transforms some object to WebPage- Returns:
- this
-
dir
public SitemapGenerator dir(String dirName)
Sets default prefix dir to name. Final name will be "dirName/name"- Parameters:
dirName
- Dir name- Returns:
- this
-
dir
public SitemapGenerator dir(String... dirNames)
Sets default prefix dirs to name. For dirs: ["a", "b", "c"], the final name will be "a/b/c/name"- Parameters:
dirNames
- Dir names- Returns:
- this
-
extension
public SitemapGenerator extension(String extension)
Sets default suffix extension. Final name will be "name.extension"- Parameters:
extension
- Extension- Returns:
- this
-
defaultPriorityMax
public SitemapGenerator defaultPriorityMax()
Sets default priority to maximum (1.0)- Returns:
- this
-
setDefaultPriority
public void setDefaultPriority(Double priority)
Sets default priority- Parameters:
priority
- Default priority
-
defaultChangeFreq
public SitemapGenerator defaultChangeFreq(ChangeFreq changeFreq)
Sets default changeFreq- Parameters:
changeFreq
- ChangeFreq- Returns:
- this
-
defaultChangeFreqAlways
public SitemapGenerator defaultChangeFreqAlways()
Sets default changeFreq to ALWAYS- Returns:
- this
-
defaultChangeFreqHourly
public SitemapGenerator defaultChangeFreqHourly()
Sets default changeFreq to HOURLY- Returns:
- this
-
defaultChangeFreqDaily
public SitemapGenerator defaultChangeFreqDaily()
Sets default changeFreq to DAILY- Returns:
- this
-
defaultChangeFreqWeekly
public SitemapGenerator defaultChangeFreqWeekly()
Sets default changeFreq to WEEKLY- Returns:
- this
-
defaultChangeFreqMonthly
public SitemapGenerator defaultChangeFreqMonthly()
Sets default changeFreq to MONTHLY- Returns:
- this
-
defaultChangeFreqYearly
public SitemapGenerator defaultChangeFreqYearly()
Sets default changeFreq to YEARLY- Returns:
- this
-
defaultChangeFreqNever
public SitemapGenerator defaultChangeFreqNever()
Sets default changeFreq to NEVER- Returns:
- this
-
-