Package cz.jiripinkas.jsitemapgenerator.generator

Class SitemapGenerator

java.lang.Object

cz.jiripinkas.jsitemapgenerator.AbstractGenerator<T>

cz.jiripinkas.jsitemapgenerator.AbstractSitemapGenerator<SitemapGenerator>

cz.jiripinkas.jsitemapgenerator.generator.SitemapGenerator

public class SitemapGenerator
extends AbstractSitemapGenerator<SitemapGenerator>

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
protected void	beforeAddPageEvent(WebPage webPage)	This method is called before adding a page to urls.
String[]	constructSitemap()	Construct sitemap into array of Strings.
SitemapGenerator	defaultChangeFreq(ChangeFreq changeFreq)	Sets default changeFreq for all following WebPages
SitemapGenerator	defaultChangeFreqAlways()	Sets default changeFreq to ALWAYS for all following WebPages
SitemapGenerator	defaultChangeFreqDaily()	Sets default changeFreq to DAILY for all following WebPages
SitemapGenerator	defaultChangeFreqHourly()	Sets default changeFreq to HOURLY for all following WebPages
SitemapGenerator	defaultChangeFreqMonthly()	Sets default changeFreq to MONTHLY for all following WebPages
SitemapGenerator	defaultChangeFreqNever()	Sets default changeFreq to NEVER for all following WebPages
SitemapGenerator	defaultChangeFreqWeekly()	Sets default changeFreq to WEEKLY for all following WebPages
SitemapGenerator	defaultChangeFreqYearly()	Sets default changeFreq to YEARLY for all following WebPages
SitemapGenerator	defaultDir(String dirName)	Sets default prefix dir to name for all following WebPages.
SitemapGenerator	defaultDir(String... dirNames)	Sets default prefix dirs to name for all following WebPages.
SitemapGenerator	defaultExtension(String extension)	Sets default suffix extension for all following WebPages.
SitemapGenerator	defaultPriority(Double priority)	Sets default priority for all following WebPages
SitemapGenerator	defaultPriorityMax()	Sets default priority for all following WebPages to maximum (1.0)
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
SitemapGenerator	resetDefaultChangeFreq()	Reset default changeFreq
SitemapGenerator	resetDefaultDir()	Reset default dir value
SitemapGenerator	resetDefaultExtension()	Reset default extension value
SitemapGenerator	resetDefaultPriority()	Reset default priority

Methods inherited from class cz.jiripinkas.jsitemapgenerator.AbstractSitemapGenerator

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

Methods inherited from class cz.jiripinkas.jsitemapgenerator.AbstractGenerator

addPage, addPages, addPages, addPages, addPages

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<SitemapGenerator>

Returns:

sitemap

beforeAddPageEvent

protected void beforeAddPageEvent(WebPage webPage)

Description copied from class: AbstractGenerator

This method is called before adding a page to urls. It can be used to change webPage attributes

Overrides:

beforeAddPageEvent in class AbstractGenerator<SitemapGenerator>

Parameters:

webPage - WebPage

defaultDir

public SitemapGenerator defaultDir(String dirName)

Sets default prefix dir to name for all following WebPages. Final name will be "dirName/name"

Parameters:

dirName - Dir name

Returns:

this

defaultDir

public SitemapGenerator defaultDir(String... dirNames)

Sets default prefix dirs to name for all following WebPages. For dirs: ["a", "b", "c"], the final name will be "a/b/c/name"

Parameters:

dirNames - Dir names

Returns:

this

resetDefaultDir

public SitemapGenerator resetDefaultDir()

Reset default dir value

Returns:

this

defaultExtension

public SitemapGenerator defaultExtension(String extension)

Sets default suffix extension for all following WebPages. Final name will be "name.extension"

Parameters:

extension - Extension

Returns:

this

resetDefaultExtension

public SitemapGenerator resetDefaultExtension()

Reset default extension value

Returns:

this

defaultPriorityMax

public SitemapGenerator defaultPriorityMax()

Sets default priority for all following WebPages to maximum (1.0)

Returns:

this

defaultPriority

public SitemapGenerator defaultPriority(Double priority)

Sets default priority for all following WebPages

Parameters:

priority - Default priority

Returns:

this

resetDefaultPriority

public SitemapGenerator resetDefaultPriority()

Reset default priority

Returns:

this

defaultChangeFreq

public SitemapGenerator defaultChangeFreq(ChangeFreq changeFreq)

Sets default changeFreq for all following WebPages

Parameters:

changeFreq - ChangeFreq

Returns:

this

defaultChangeFreqAlways

public SitemapGenerator defaultChangeFreqAlways()

Sets default changeFreq to ALWAYS for all following WebPages

Returns:

this

defaultChangeFreqHourly

public SitemapGenerator defaultChangeFreqHourly()

Sets default changeFreq to HOURLY for all following WebPages

Returns:

this

defaultChangeFreqDaily

public SitemapGenerator defaultChangeFreqDaily()

Sets default changeFreq to DAILY for all following WebPages

Returns:

this

defaultChangeFreqWeekly

public SitemapGenerator defaultChangeFreqWeekly()

Sets default changeFreq to WEEKLY for all following WebPages

Returns:

this

defaultChangeFreqMonthly

public SitemapGenerator defaultChangeFreqMonthly()

Sets default changeFreq to MONTHLY for all following WebPages

Returns:

this

defaultChangeFreqYearly

public SitemapGenerator defaultChangeFreqYearly()

Sets default changeFreq to YEARLY for all following WebPages

Returns:

this

defaultChangeFreqNever

public SitemapGenerator defaultChangeFreqNever()

Sets default changeFreq to NEVER for all following WebPages

Returns:

this

resetDefaultChangeFreq

public SitemapGenerator resetDefaultChangeFreq()

Reset default changeFreq

Returns:

this