Package cz.jiripinkas.jsitemapgenerator.generator

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. Use of(String)
SitemapGenerator(String baseUrl, SitemapGenerator.AdditionalNamespace[] additionalNamespaces)	Deprecated. Use of(String, AdditionalNamespace[]) )}

Method Summary

Modifier and Type	Method	Description
SitemapGenerator	addPage(WebPage webPage)	Add single page to sitemap
SitemapGenerator	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 sitemap
String[]	constructSitemap()	Construct sitemap into array of Strings.
SitemapGenerator	defaultChangeFreq(ChangeFreq changeFreq)	Sets default changeFreq
SitemapGenerator	defaultChangeFreqAlways()	Sets default changeFreq to ALWAYS
SitemapGenerator	defaultChangeFreqDaily()	Sets default changeFreq to DAILY
SitemapGenerator	defaultChangeFreqHourly()	Sets default changeFreq to HOURLY
SitemapGenerator	defaultChangeFreqMonthly()	Sets default changeFreq to MONTHLY
SitemapGenerator	defaultChangeFreqNever()	Sets default changeFreq to NEVER
SitemapGenerator	defaultChangeFreqWeekly()	Sets default changeFreq to WEEKLY
SitemapGenerator	defaultChangeFreqYearly()	Sets default changeFreq to YEARLY
SitemapGenerator	defaultPriorityMax()	Sets default priority to maximum (1.0)
SitemapGenerator	nameBasePrefixDir(String dirName)	Sets default prefix dir to name.
SitemapGenerator	nameBasePrefixDir(String... dirNames)	Sets default prefix dirs to name.
SitemapGenerator	nameBaseSuffixExtension(String extension)	Sets default suffix extension.
static SitemapGenerator	of(String baseUrl)	Helper method to create an instance of SitemapGenerator
static SitemapGenerator	of(String baseUrl, SitemapGenerator.AdditionalNamespace[] additionalNamespaces)	Helper method to create an instance of SitemapGenerator
void	setDefaultPriority(Double priority)	Sets default priority

Methods inherited from class cz.jiripinkas.jsitemapgenerator.AbstractSitemapGenerator

constructAndSaveSitemap, constructSitemapString, escapeXmlSpecialCharacters, pingBing, pingBing, pingGoogle, pingGoogle, saveSitemap

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SitemapGenerator

@Deprecated
public SitemapGenerator(String baseUrl)

Deprecated.

Use of(String)

Parameters:

baseUrl - Base URL

SitemapGenerator

@Deprecated
public SitemapGenerator(String baseUrl,
                        SitemapGenerator.AdditionalNamespace[] additionalNamespaces)

Deprecated.

Use of(String, AdditionalNamespace[]) )}

Parameters:

baseUrl - Base URL

additionalNamespaces - 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 URL

additionalNamespaces - 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 class AbstractSitemapGenerator

Returns:

sitemap

addPage

public SitemapGenerator addPage(WebPage webPage)

Add single page to sitemap

Overrides:

addPage in class AbstractGenerator

Parameters:

webPage - single page

Returns:

this

addPages

public SitemapGenerator addPages(Collection<WebPage> webPages)

Add collection of pages to sitemap

Overrides:

addPages in class AbstractGenerator

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 class AbstractGenerator

Type Parameters:

T - This is the type parameter

Parameters:

webPages - Collection of pages

mapper - Mapper function which transforms some object to WebPage

Returns:

this

nameBasePrefixDir

public SitemapGenerator nameBasePrefixDir(String dirName)

Sets default prefix dir to name. Final name will be "dirName/name"

Parameters:

dirName - Dir name

Returns:

this

nameBasePrefixDir

public SitemapGenerator nameBasePrefixDir(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

nameBaseSuffixExtension

public SitemapGenerator nameBaseSuffixExtension(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