io.micronaut.rss

Class RssChannel

java.lang.Object

io.micronaut.rss.RssChannel

Direct Known Subclasses:

ItunesPodcast

public class RssChannel
extends java.lang.Object

Since:

1.0

Author:

Sergio del Amo

See Also:

RSS 2.0 Specification

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	RSS_LANGUAGE_CODE_REGEX

Constructor Summary

Constructors

Constructor and Description
RssChannel()

Method Summary

Modifier and Type	Method and Description
void	addItem(RssItem item)
static io.micronaut.rss.RssChannel.Builder	builder(java.lang.String title, java.lang.String link, java.lang.String description)
java.util.Optional<java.util.List<java.util.List<java.lang.String>>>	getCategory() Specify one or more categories that the channel belongs to.
java.util.Optional<java.lang.String>	getCloud() Allows processes to register with a cloud to be notified of updates to the channel, implementing a lightweight publish-subscribe protocol for RSS feeds.
java.util.Optional<java.lang.String>	getCopyright() Copyright notice for content in the channel.
java.lang.String	getDescription() Phrase or sentence describing the channel.
java.util.Optional<java.lang.String>	getDocs() A URL that points to the documentation for the format used in the RSS file.
java.util.Optional<java.lang.String>	getGenerator() A string indicating the program used to generate the channel.
java.util.Optional<RssChannelImage>	getImage() Specifies a GIF, JPEG or PNG image that can be displayed with the channel.
java.util.Optional<java.util.List<RssItem>>	getItem() An item may represent a "story" -- much like a story in a newspaper or magazine; if so its description is a synopsis of the story, and the link points to the full story.
java.util.Optional<RssLanguage>	getLanguage() The language the channel is written in.
java.util.Optional<java.time.ZonedDateTime>	getLastBuildDate() The last time the content of the channel changed.
java.lang.String	getLink()
java.util.Optional<java.lang.String>	getManagingEditor()
java.util.Optional<java.time.ZonedDateTime>	getPubDate() The publication date for the content in the channel.
java.util.Optional<java.lang.String>	getRating() The PICS rating for the channel.
java.util.Optional<java.util.List<RssSkipDays>>	getSkipDays() A hint for aggregators telling them which days they can skip.
java.util.Optional<java.util.List<RssSkipHours>>	getSkipHours() A hint for aggregators telling them which hours they can skip.
java.util.Optional<RssTextInput>	getTextInput() Specifies a text input box that can be displayed with the channel.
java.lang.String	getTitle() The name of the channel.
java.util.Optional<java.lang.Integer>	getTtl() ttl stands for time to live.
java.util.Optional<java.lang.String>	getWebMaster()
void	setCategory(java.util.List<java.util.List<java.lang.String>> category)
void	setCloud(java.lang.String cloud)
void	setCopyright(java.lang.String copyright)
void	setDescription(java.lang.String description)
void	setDocs(java.lang.String docs)
void	setGenerator(java.lang.String generator)
void	setImage(RssChannelImage image)
void	setItem(java.util.List<RssItem> item)
void	setLanguage(RssLanguage language)
void	setLastBuildDate(java.time.ZonedDateTime lastBuildDate)
void	setLink(java.lang.String link)
void	setManagingEditor(java.lang.String managingEditor)
void	setPubDate(java.time.ZonedDateTime pubDate)
void	setRating(java.lang.String rating)
void	setSkipDays(java.util.List<RssSkipDays> skipDays)
void	setSkipHours(java.util.List<RssSkipHours> skipHours)
void	setTextInput(RssTextInput textInput)
void	setTitle(java.lang.String title)
void	setTtl(java.lang.Integer ttl)
void	setWebMaster(java.lang.String webMaster)

Methods inherited from class java.lang.Object

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

Field Detail

RSS_LANGUAGE_CODE_REGEX

public static final java.lang.String RSS_LANGUAGE_CODE_REGEX

See Also:

Constant Field Values

Constructor Detail

RssChannel

public RssChannel()

Method Detail

getTitle

public java.lang.String getTitle()

The name of the channel.

It's how people refer to your service. If you have an HTML website that contains the same information as your RSS file, the title of your channel should be the same as the title of your website.

Returns:

The name of the channel.

getLink

public java.lang.String getLink()

Returns:

The URL to the HTML website corresponding to the channel.

getDescription

public java.lang.String getDescription()

Phrase or sentence describing the channel.

Returns:

Phrase or sentence describing the channel.

getLanguage

public java.util.Optional<RssLanguage> getLanguage()

The language the channel is written in. This allows aggregators to group all Italian language sites, for example, on a single page. A list of allowable values for this element, as provided by Netscape, is here. You may also use values defined by the W3C

Returns:

The language the channel is written in.

getCopyright

public java.util.Optional<java.lang.String> getCopyright()

Copyright notice for content in the channel.

Returns:

Copyright notice for content in the channel.

getManagingEditor

public java.util.Optional<java.lang.String> getManagingEditor()

Returns:

Email address for person responsible for editorial content.

getWebMaster

public java.util.Optional<java.lang.String> getWebMaster()

Returns:

Email address for person responsible for technical issues relating to channel.

getPubDate

public java.util.Optional<java.time.ZonedDateTime> getPubDate()

The publication date for the content in the channel. For example, the New York Times publishes on a daily basis, the publication date flips once every 24 hours. That's when the pubDate of the channel changes. All date-times in RSS conform to the Date and Time Specification of RFC 822, with the exception that the year may be expressed with two characters or four characters (four preferred).

Returns:

The publication date for the content in the channel.

getLastBuildDate

public java.util.Optional<java.time.ZonedDateTime> getLastBuildDate()

The last time the content of the channel changed.

Returns:

The last time the content of the channel changed.

getCategory

public java.util.Optional<java.util.List<java.util.List<java.lang.String>>> getCategory()

Specify one or more categories that the channel belongs to. Follows the same rules as the -level category element. More info.

Returns:

Specify one or more categories that the channel belongs to.

getGenerator

public java.util.Optional<java.lang.String> getGenerator()

A string indicating the program used to generate the channel.

Returns:

A string indicating the program used to generate the channel.

getDocs

public java.util.Optional<java.lang.String> getDocs()

A URL that points to the documentation for the format used in the RSS file. It's probably a pointer to this page. It's for people who might stumble across an RSS file on a Web server 25 years from now and wonder what it is.

Returns:

A URL that points to the documentation for the format used in the RSS file

getCloud

public java.util.Optional<java.lang.String> getCloud()

Allows processes to register with a cloud to be notified of updates to the channel, implementing a lightweight publish-subscribe protocol for RSS feeds. More info here.

Returns:

Allows processes to register with a cloud to be notified of updates to the channel, implementing a lightweight publish-subscribe protocol for RSS feeds.

getTtl

public java.util.Optional<java.lang.Integer> getTtl()

ttl stands for time to live. It's a number of minutes that indicates how long a channel can be cached before refreshing from the source. More info here.

Returns:

It's a number of minutes that indicates how long a channel can be cached before refreshing from the source.

getImage

public java.util.Optional<RssChannelImage> getImage()

Specifies a GIF, JPEG or PNG image that can be displayed with the channel. More info here.

Returns:

Specifies a GIF, JPEG or PNG image that can be displayed with the channel.

getRating

public java.util.Optional<java.lang.String> getRating()

The PICS rating for the channel.

Returns:

The PICS rating for the channel.

getTextInput

public java.util.Optional<RssTextInput> getTextInput()

Specifies a text input box that can be displayed with the channel.

Returns:

An optional RssTextInput

getSkipHours

public java.util.Optional<java.util.List<RssSkipHours>> getSkipHours()

A hint for aggregators telling them which hours they can skip.

Returns:

A hint for aggregators telling them which hours they can skip.

getSkipDays

public java.util.Optional<java.util.List<RssSkipDays>> getSkipDays()

A hint for aggregators telling them which days they can skip.

Returns:

A hint for aggregators telling them which days they can skip.

getItem

public java.util.Optional<java.util.List<RssItem>> getItem()

An item may represent a "story" -- much like a story in a newspaper or magazine; if so its description is a synopsis of the story, and the link points to the full story.

Returns:

An optional List of RssItem

addItem

public void addItem(RssItem item)

Parameters:

item - a RSS Item

setSkipDays

public void setSkipDays(java.util.List<RssSkipDays> skipDays)

Parameters:

skipDays - a List of RssSkipDays

setSkipHours

public void setSkipHours(java.util.List<RssSkipHours> skipHours)

Parameters:

skipHours - a List of RssSkipHours.

setTextInput

public void setTextInput(RssTextInput textInput)

Parameters:

textInput - A RssTextInput.

setRating

public void setRating(java.lang.String rating)

Parameters:

rating - A PICS Rating.

setImage

public void setImage(RssChannelImage image)

Parameters:

image - GIF, JPEG or PNG image that can be displayed with the channel.

setTtl

public void setTtl(java.lang.Integer ttl)

Parameters:

ttl - time to live expressed in minutes.

setCloud

public void setCloud(java.lang.String cloud)

Parameters:

cloud - A cloud.

setDocs

public void setDocs(java.lang.String docs)

Parameters:

docs - A URL that points to the documentation for the format used in the RSS file.

setGenerator

public void setGenerator(java.lang.String generator)

Parameters:

generator - A string indicating the program used to generate the channel.

setCategory

public void setCategory(java.util.List<java.util.List<java.lang.String>> category)

Parameters:

category - A list of categories to associate the RSS Channel with.

setLastBuildDate

public void setLastBuildDate(java.time.ZonedDateTime lastBuildDate)

Parameters:

lastBuildDate - The last time the content of the channel changed.

setPubDate

public void setPubDate(java.time.ZonedDateTime pubDate)

Parameters:

pubDate - The publication date for the content in the channel.

setWebMaster

public void setWebMaster(java.lang.String webMaster)

Parameters:

webMaster - Email address for person responsible for technical issues relating to channel.

setManagingEditor

public void setManagingEditor(java.lang.String managingEditor)

Parameters:

managingEditor - Email address for person responsible for editorial content.

setCopyright

public void setCopyright(java.lang.String copyright)

Parameters:

copyright - Copyright notice for content in the channel.

setLanguage

public void setLanguage(RssLanguage language)

Parameters:

language - The language the channel is written in.

setDescription

public void setDescription(java.lang.String description)

Parameters:

description - Phrase or sentence describing the channel.

setLink

public void setLink(java.lang.String link)

Parameters:

link - The URL to the HTML website corresponding to the channel.

setTitle

public void setTitle(java.lang.String title)

Parameters:

title - The name of the channel.

setItem

public void setItem(java.util.List<RssItem> item)

Parameters:

item - A RSS Item.

builder

public static io.micronaut.rss.RssChannel.Builder builder(java.lang.String title,
                                                          java.lang.String link,
                                                          java.lang.String description)

Parameters:

title - The name of the channel.

link - The URL to the HTML website corresponding to the channel.

description - Phrase or sentence describing the channel.

Returns:

A Builder to build a RssChannel.