Module cz.jiripinkas.jsitemapgenerator

Package cz.jiripinkas.jsitemapgenerator.generator

Class RssGenerator

java.lang.Object

cz.jiripinkas.jsitemapgenerator.AbstractGenerator<RssGenerator>

cz.jiripinkas.jsitemapgenerator.generator.RssGenerator

public class RssGenerator
extends AbstractGenerator<RssGenerator>

Nested Class Summary

Nested classes/interfaces inherited from class cz.jiripinkas.jsitemapgenerator.AbstractGenerator

AbstractGenerator.GeneratorConsumerWithException<T>, AbstractGenerator.RunnableWithException, AbstractGenerator.StringSupplierWithException<S>

Field Summary

Fields inherited from class cz.jiripinkas.jsitemapgenerator.AbstractGenerator

baseUrl, urls

Method Summary

Modifier and Type	Method	Description
protected void	beforeAddPageEvent(WebPage webPage)	This method is called before adding a page to urls.
RssGenerator	defaultDir(String dirName)	Sets default prefix dir to name for all subsequent WebPages.
RssGenerator	defaultDir(String... dirNames)	Sets default prefix dirs to name for all subsequent WebPages.
RssGenerator	defaultExtension(String extension)	Sets default suffix extension for all subsequent WebPages.
static RssGenerator	of(String baseUrl)	Helper method to create an instance of SitemapGenerator
static RssGenerator	of(String baseUrl, boolean root)	Helper method to create an instance of SitemapGenerator
static RssGenerator	of(String baseUrl, boolean root, String webTitle, String webDescription)	Helper method to create an instance of SitemapGenerator
static RssGenerator	of(String baseUrl, String webTitle, String webDescription)	Helper method to create an instance of SitemapGenerator
RssGenerator	resetDefaultDir()	Reset default dir value
RssGenerator	resetDefaultExtension()	Reset default extension value
String	toString()	This will construct RSS from web pages.
RssGenerator	webDescription(String webDescription)	Set Web description
RssGenerator	webTitle(String webTitle)	Set Web title

Methods inherited from class cz.jiripinkas.jsitemapgenerator.AbstractGenerator

addPage, addPage, addPage, addPageNames, addPageNames, addPages, addPages, addPages, addPages, getThis, run, run, toPrettyXmlString

Methods inherited from class java.lang.Object

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

Method Detail

of

public static RssGenerator of(String baseUrl,
                              boolean root,
                              String webTitle,
                              String webDescription)

Helper method to create an instance of SitemapGenerator

Parameters:

baseUrl - Base URL

root - If Base URL is root (for example http://www.javavids.com or if it's some path like http://www.javalibs.com/blog)

webTitle - Web title

webDescription - Web description

Returns:

Instance of RssGenerator

of

public static RssGenerator of(String baseUrl,
                              boolean root)

Helper method to create an instance of SitemapGenerator

Parameters:

baseUrl - Base URL

root - If Base URL is root (for example http://www.javavids.com or if it's some path like http://www.javalibs.com/blog)

Returns:

Instance of RssGenerator

of

public static RssGenerator of(String baseUrl,
                              String webTitle,
                              String webDescription)

Helper method to create an instance of SitemapGenerator

Parameters:

baseUrl - Base URL

webTitle - Web title

webDescription - Web description

Returns:

Instance of RssGenerator

of

public static RssGenerator of(String baseUrl)

Helper method to create an instance of SitemapGenerator

Parameters:

baseUrl - Base URL

Returns:

Instance of RssGenerator

webTitle

public RssGenerator webTitle(String webTitle)

Set Web title

Parameters:

webTitle - Web title

Returns:

this

webDescription

public RssGenerator webDescription(String webDescription)

Set Web description

Parameters:

webDescription - Web description

Returns:

this

toString

public String toString()

This will construct RSS from web pages. Web pages are sorted using lastMod in descending order (latest is first)

Overrides:

toString in class Object

Returns:

Constructed RSS

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

Parameters:

webPage - WebPage

defaultDir

public RssGenerator defaultDir(String dirName)

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

Parameters:

dirName - Dir name

Returns:

this

defaultDir

public RssGenerator defaultDir(String... dirNames)

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

Parameters:

dirNames - Dir names

Returns:

this

resetDefaultDir

public RssGenerator resetDefaultDir()

Reset default dir value

Returns:

this

defaultExtension

public RssGenerator defaultExtension(String extension)

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

Parameters:

extension - Extension

Returns:

this

resetDefaultExtension

public RssGenerator resetDefaultExtension()

Reset default extension value

Returns:

this