Top Description Fields Constructors Methods
com.rometools.rome.feed.rss

public Class Channel

extends WireFeed
Class Inheritance
Imports
java.util.Collections, .Date, .HashSet, .List, .Set, com.rometools.rome.feed.WireFeed, com.rometools.rome.feed.module.Module, com.rometools.rome.feed.module.impl.ModuleUtils, com.rometools.utils.Dates, .Lists
Bean for RSS feeds.

It handles all RSS versions (0.9, 0.91, 0.92, 0.93, 0.94, 1.0 and 2.0) without losing information.

Field Summary

Modifier and TypeField and Description
private List<Category>
categories

private Cloud
cloud

private String
copyright

private static final Set<String>
DAYS

private String
description

private String
docs

public static final String
FRIDAY

private String
generator

private Image
image

private List<Item>
items

private String
language

private Date
lastBuildDate

private String
link

private String
managingEditor

private List<Module>
modules

Hides com.rometools.rome.feed.WireFeed.modules.

public static final String
MONDAY

private Date
pubDate

private String
rating

public static final String
SATURDAY

private static final long
serialVersionUID

Hides com.rometools.rome.feed.WireFeed.serialVersionUID.

private List<String>
skipDays

private List<Integer>
skipHours

public static final String
SUNDAY

private TextInput
textInput

public static final String
THURSDAY

private String
title

private int
ttl

public static final String
TUESDAY

private String
uri

private String
webMaster

public static final String
WEDNESDAY

Constructor Summary

AccessConstructor and Description
public
Channel()

Default constructor, for bean cloning purposes only.

public
Channel(final String
the type of the RSS feed.
type)

Channel Constructor.

Method Summary

Modifier and TypeMethod and Description
public List<Category>

Returns:

a list of Category elements with the channel categories, an empty list if none.
getCategories()

Returns the channel categories.

public Cloud

Returns:

the channel cloud, null if none.
getCloud()

Returns the channel cloud.

public String

Returns:

the channel copyright, null if none.
getCopyright()

Returns the channel copyright.

public String

Returns:

the channel description, null if none.
getDescription()

Returns the channel description.

public String

Returns:

the channel docs, null if none.
getDocs()

Returns the channel docs.

public String

Returns:

the channel generator, null if none.
getGenerator()

Returns the channel generator.

public Image

Returns:

the channel image, null if none.
getImage()

Returns the channel image.

public List<Item>

Returns:

a list of Item elements with the channel items, an empty list if none.
getItems()

Returns the channel items.

public String

Returns:

the channel language, null if none.
getLanguage()

Returns the channel language.

public Date

Returns:

the channel last build date, null if none.
getLastBuildDate()

Returns the channel last build date.

public String

Returns:

the channel managing editor, null if none.
getManagingEditor()

Returns the channel managing editor.

public Module

Returns:

The module with the given URI, null if none.
getModule(final String
the URI of the ModuleImpl.
uri)

Overrides com.rometools.rome.feed.WireFeed.getModule.

Implements com.rometools.rome.feed.module.Extendable.getModule.

Returns the module identified by a given URI.
public List<Module>

Returns:

a list of ModuleImpl elements with the channel modules, an empty list if none.
getModules()

Overrides com.rometools.rome.feed.WireFeed.getModules.

Implements com.rometools.rome.feed.module.Extendable.getModules.

Returns the channel modules.
public Date

Returns:

the channel publishing date, null if none.
getPubDate()

Returns the channel publishing date.

public String

Returns:

the channel rating, null if none.
getRating()

Returns the channel rating.

public List<String>

Returns:

a list of Day elements with the channel skip days, an empty list if none.
getSkipDays()

Returns the channel skip days.

public List<Integer>

Returns:

a list of Integer elements with the channel skip hours, an empty list if none.
getSkipHours()

Returns the channel skip hours.

public TextInput

Returns:

the channel text input, null if none.
getTextInput()

Returns the channel text input.

public String

Returns:

the channel title, null if none.
getTitle()

Returns the channel title.

public int

Returns:

the channel time to live, null if none.
getTtl()

Returns the channel time to live.

public String

Returns:

the channel uri, null if none.
getUri()

Returns the channel uri.

public String

Returns:

the channel web master, null if none.
getWebMaster()

Returns the channel web master.

public void
setCategories(final List<Category>
the list of Category elements with the channel categories to set, an empty list or null if none.
categories)

Sets the channel categories.

public void
setCloud(final Cloud
the channel cloud to set, null if none.
cloud)

Sets the channel cloud.

public void
setCopyright(final String
the channel copyright to set, null if none.
copyright)

Sets the channel copyright.

public void
setDescription(final String
the channel description to set, null if none.
description)

Sets the channel description.

public void
setDocs(final String
the channel docs to set, null if none.
docs)

Sets the channel docs.

public void
setGenerator(final String
the channel generator to set, null if none.
generator)

Sets the channel generator.

public void
setImage(final Image
the channel image to set, null if none.
image)

Sets the channel image.

public void
setItems(final List<Item>
the list of Item elements with the channel items to set, an empty list or null if none.
items)

Sets the channel items.

public void
setLanguage(final String
the channel language to set, null if none.
language)

Sets the channel language.

public void
setLastBuildDate(final Date
the channel last build date to set, null if none.
lastBuildDate)

Sets the channel last build date.

public void
setManagingEditor(final String
the channel managing editor to set, null if none.
managingEditor)

Sets the channel managing editor.

public void
setModules(final List<Module>
the list of ModuleImpl elements with the channel modules to set, an empty list or null if none.
modules)

Overrides com.rometools.rome.feed.WireFeed.setModules.

Implements com.rometools.rome.feed.module.Extendable.setModules.

Sets the channel modules.
public void
setPubDate(final Date
the channel publishing date to set, null if none.
pubDate)

Sets the channel publishing date.

public void
setRating(final String
the channel rating to set, null if none.
rating)

Sets the channel rating.

public void
setSkipDays(final List<String>
the list of Day elements with the channel skip days to set, an empty list or null if none.
skipDays)

Sets the channel skip days.

public void
setSkipHours(final List<Integer>
the list of Integer elements with the channel skip hours to set, an empty list or null if none.
skipHours)

Sets the channel skip hours.

public void
setTextInput(final TextInput
the channel text input to set, null if none.
textInput)

Sets the channel text input.

public void
setTitle(final String
the channel title to set, null if none.
title)

Sets the channel title.

public void
setTtl(final int
the channel time to live to set, null if none.
ttl)

Sets the channel time to live.

public void
setUri(final String
the channel uri, null if none.
uri)

Sets the channel uri.

public void
setWebMaster(final String
the channel web master to set, null if none.
webMaster)

Sets the channel web master.

Inherited from com.rometools.rome.feed.WireFeed:
cloneequalsgetEncodinggetFeedTypegetForeignMarkupgetStyleSheethashCodesetEncodingsetFeedTypesetForeignMarkupsetStyleSheettoString

Field Detail

categoriesback to summary
private List<Category> categories
cloudback to summary
private Cloud cloud
DAYSback to summary
private static final Set<String> DAYS
descriptionback to summary
private String description
docsback to summary
private String docs
FRIDAYback to summary
public static final String FRIDAY
generatorback to summary
private String generator
imageback to summary
private Image image
itemsback to summary
private List<Item> items
languageback to summary
private String language
lastBuildDateback to summary
private Date lastBuildDate
managingEditorback to summary
private String managingEditor
modulesback to summary
private List<Module> modules

Hides com.rometools.rome.feed.WireFeed.modules.

MONDAYback to summary
public static final String MONDAY
pubDateback to summary
private Date pubDate
ratingback to summary
private String rating
SATURDAYback to summary
public static final String SATURDAY
serialVersionUIDback to summary
private static final long serialVersionUID

Hides com.rometools.rome.feed.WireFeed.serialVersionUID.

skipDaysback to summary
private List<String> skipDays
skipHoursback to summary
private List<Integer> skipHours
SUNDAYback to summary
public static final String SUNDAY
textInputback to summary
private TextInput textInput
THURSDAYback to summary
public static final String THURSDAY
titleback to summary
private String title
ttlback to summary
private int ttl
TUESDAYback to summary
public static final String TUESDAY
uriback to summary
private String uri
webMasterback to summary
private String webMaster
WEDNESDAYback to summary
public static final String WEDNESDAY

Constructor Detail

Channelback to summary
public Channel()

Default constructor, for bean cloning purposes only.

Channelback to summary
public Channel(final String type)

Channel Constructor. All properties, except the type, are set to null.

Parameters
type:String

the type of the RSS feed.

Method Detail

getCategoriesback to summary
public List<Category> getCategories()

Returns the channel categories.

Returns:List<Category>

a list of Category elements with the channel categories, an empty list if none.

getCloudback to summary
public Cloud getCloud()

Returns the channel cloud.

Returns:Cloud

the channel cloud, null if none.

getCopyrightback to summary
public String getCopyright()

Returns the channel copyright.

Returns:String

the channel copyright, null if none.

getDescriptionback to summary
public String getDescription()

Returns the channel description.

Returns:String

the channel description, null if none.

getDocsback to summary
public String getDocs()

Returns the channel docs.

Returns:String

the channel docs, null if none.

getGeneratorback to summary
public String getGenerator()

Returns the channel generator.

Returns:String

the channel generator, null if none.

getImageback to summary
public Image getImage()

Returns the channel image.

Returns:Image

the channel image, null if none.

getItemsback to summary
public List<Item> getItems()

Returns the channel items.

Returns:List<Item>

a list of Item elements with the channel items, an empty list if none.

getLanguageback to summary
public String getLanguage()

Returns the channel language.

Returns:String

the channel language, null if none.

getLastBuildDateback to summary
public Date getLastBuildDate()

Returns the channel last build date.

Returns:Date

the channel last build date, null if none.

getLinkback to summary
public String getLink()

Returns the channel link.

Returns:String

the channel link, null if none.

getManagingEditorback to summary
public String getManagingEditor()

Returns the channel managing editor.

Returns:String

the channel managing editor, null if none.

getModuleback to summary
public Module getModule(final String uri)

Overrides com.rometools.rome.feed.WireFeed.getModule.

Implements com.rometools.rome.feed.module.Extendable.getModule.

Returns the module identified by a given URI.

Parameters
uri:String

the URI of the ModuleImpl.

Returns:Module

The module with the given URI, null if none.

Annotations
@Override
getModulesback to summary
public List<Module> getModules()

Overrides com.rometools.rome.feed.WireFeed.getModules.

Implements com.rometools.rome.feed.module.Extendable.getModules.

Returns the channel modules.

Returns:List<Module>

a list of ModuleImpl elements with the channel modules, an empty list if none.

Annotations
@Override
getPubDateback to summary
public Date getPubDate()

Returns the channel publishing date.

Returns:Date

the channel publishing date, null if none.

getRatingback to summary
public String getRating()

Returns the channel rating.

Returns:String

the channel rating, null if none.

getSkipDaysback to summary
public List<String> getSkipDays()

Returns the channel skip days.

Returns:List<String>

a list of Day elements with the channel skip days, an empty list if none.

getSkipHoursback to summary
public List<Integer> getSkipHours()

Returns the channel skip hours.

Returns:List<Integer>

a list of Integer elements with the channel skip hours, an empty list if none.

getTextInputback to summary
public TextInput getTextInput()

Returns the channel text input.

Returns:TextInput

the channel text input, null if none.

getTitleback to summary
public String getTitle()

Returns the channel title.

Returns:String

the channel title, null if none.

getTtlback to summary
public int getTtl()

Returns the channel time to live.

Returns:int

the channel time to live, null if none.

getUriback to summary
public String getUri()

Returns the channel uri.

Returns:String

the channel uri, null if none.

getWebMasterback to summary
public String getWebMaster()

Returns the channel web master.

Returns:String

the channel web master, null if none.

setCategoriesback to summary
public void setCategories(final List<Category> categories)

Sets the channel categories.

Parameters
categories:List<Category>

the list of Category elements with the channel categories to set, an empty list or null if none.

setCloudback to summary
public void setCloud(final Cloud cloud)

Sets the channel cloud.

Parameters
cloud:Cloud

the channel cloud to set, null if none.

setCopyrightback to summary
public void setCopyright(final String copyright)

Sets the channel copyright.

Parameters
copyright:String

the channel copyright to set, null if none.

setDescriptionback to summary
public void setDescription(final String description)

Sets the channel description.

Parameters
description:String

the channel description to set, null if none.

setDocsback to summary
public void setDocs(final String docs)

Sets the channel docs.

Parameters
docs:String

the channel docs to set, null if none.

setGeneratorback to summary
public void setGenerator(final String generator)

Sets the channel generator.

Parameters
generator:String

the channel generator to set, null if none.

setImageback to summary
public void setImage(final Image image)

Sets the channel image.

Parameters
image:Image

the channel image to set, null if none.

setItemsback to summary
public void setItems(final List<Item> items)

Sets the channel items.

Parameters
items:List<Item>

the list of Item elements with the channel items to set, an empty list or null if none.

setLanguageback to summary
public void setLanguage(final String language)

Sets the channel language.

Parameters
language:String

the channel language to set, null if none.

setLastBuildDateback to summary
public void setLastBuildDate(final Date lastBuildDate)

Sets the channel last build date.

Parameters
lastBuildDate:Date

the channel last build date to set, null if none.

setLinkback to summary
public void setLink(final String link)

Sets the channel link.

Parameters
link:String

the channel link to set, null if none.

setManagingEditorback to summary
public void setManagingEditor(final String managingEditor)

Sets the channel managing editor.

Parameters
managingEditor:String

the channel managing editor to set, null if none.

setModulesback to summary
public void setModules(final List<Module> modules)

Overrides com.rometools.rome.feed.WireFeed.setModules.

Implements com.rometools.rome.feed.module.Extendable.setModules.

Sets the channel modules.

Parameters
modules:List<Module>

the list of ModuleImpl elements with the channel modules to set, an empty list or null if none.

Annotations
@Override
setPubDateback to summary
public void setPubDate(final Date pubDate)

Sets the channel publishing date.

Parameters
pubDate:Date

the channel publishing date to set, null if none.

setRatingback to summary
public void setRating(final String rating)

Sets the channel rating.

Parameters
rating:String

the channel rating to set, null if none.

setSkipDaysback to summary
public void setSkipDays(final List<String> skipDays)

Sets the channel skip days.

Parameters
skipDays:List<String>

the list of Day elements with the channel skip days to set, an empty list or null if none.

setSkipHoursback to summary
public void setSkipHours(final List<Integer> skipHours)

Sets the channel skip hours.

Parameters
skipHours:List<Integer>

the list of Integer elements with the channel skip hours to set, an empty list or null if none.

setTextInputback to summary
public void setTextInput(final TextInput textInput)

Sets the channel text input.

Parameters
textInput:TextInput

the channel text input to set, null if none.

setTitleback to summary
public void setTitle(final String title)

Sets the channel title.

Parameters
title:String

the channel title to set, null if none.

setTtlback to summary
public void setTtl(final int ttl)

Sets the channel time to live.

Parameters
ttl:int

the channel time to live to set, null if none.

setUriback to summary
public void setUri(final String uri)

Sets the channel uri.

Parameters
uri:String

the channel uri, null if none.

setWebMasterback to summary
public void setWebMaster(final String webMaster)

Sets the channel web master.

Parameters
webMaster:String

the channel web master to set, null if none.