Package cz.jiripinkas.jsitemapgenerator.generator

Class RssGenerator

java.lang.Object

cz.jiripinkas.jsitemapgenerator.AbstractGenerator

cz.jiripinkas.jsitemapgenerator.generator.RssGenerator

public class RssGenerator
extends AbstractGenerator

Field Summary

Fields inherited from class cz.jiripinkas.jsitemapgenerator.AbstractGenerator

baseUrl, urls

Constructor Summary

Constructors

Constructor	Description
RssGenerator(String baseUrl, boolean root, String webTitle, String webDescription)	Deprecated. use of(String, boolean, String, String)
RssGenerator(String baseUrl, String webTitle, String webDescription)	Deprecated. use of(String, String, String)

Method Summary

Modifier and Type	Method	Description
RssGenerator	addPage(WebPage webPage)	Add single page to sitemap
RssGenerator	addPages(Collection<WebPage> webPages)	Add collection of pages to sitemap
<T> RssGenerator	addPages(Collection<T> webPages, java.util.function.Function<T,WebPage> mapper)	Add collection of pages to sitemap
String	constructRss()	This will construct RSS from web pages.
static RssGenerator	of(String baseUrl)	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	webDescription(String webDescription)	Set Web description
RssGenerator	webTitle(String webTitle)	Set Web title

Methods inherited from class java.lang.Object

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

Constructor Detail

RssGenerator

@Deprecated
public RssGenerator(String baseUrl,
                    boolean root,
                    String webTitle,
                    String webDescription)

Deprecated.

use of(String, boolean, String, String)

Create RssGenerator

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

RssGenerator

@Deprecated
public RssGenerator(String baseUrl,
                    String webTitle,
                    String webDescription)

Deprecated.

use of(String, String, String)

Create RssGenerator. Root = true.

Parameters:

baseUrl - Base URL

webTitle - Web title

webDescription - Web description

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

constructRss

public String constructRss()

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

Returns:

Constructed RSS

addPage

public RssGenerator addPage(WebPage webPage)

Add single page to sitemap

Overrides:

addPage in class AbstractGenerator

Parameters:

webPage - single page

Returns:

this

addPages

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