com.sun.syndication.feed.rss

Class Channel

public class Channel extends WireFeed

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.

Author: Alejandro Abdelnur

Field Summary
static SetDAYS
static StringFRIDAY
static StringMONDAY
static StringSATURDAY
static StringSUNDAY
static StringTHURSDAY
static StringTUESDAY
static StringWEDNESDAY
List_categories
Cloud_cloud
String_copyright
String_description
String_docs
String_generator
Image_image
List_items
String_language
Date_lastBuildDate
String_link
String_managingEditor
List_modules
Date_pubDate
String_rating
List_skipDays
List_skipHours
TextInput_textInput
String_title
int_ttl
String_uri
String_webMaster
Constructor Summary
Channel()
Default constructor, for bean cloning purposes only.
Channel(String type)
Channel Constructor.
Method Summary
ListgetCategories()
Returns the channel categories.
CloudgetCloud()
Returns the channel cloud.
StringgetCopyright()
Returns the channel copyright.
StringgetDescription()
Returns the channel description.
StringgetDocs()
Returns the channel docs.
StringgetGenerator()
Returns the channel generator.
ImagegetImage()
Returns the channel image.
ListgetItems()
Returns the channel items.
StringgetLanguage()
Returns the channel language.
DategetLastBuildDate()
Returns the channel last build date.
StringgetLink()
Returns the channel link.
StringgetManagingEditor()
Returns the channel managing editor.
ModulegetModule(String uri)
Returns the module identified by a given URI.
ListgetModules()
Returns the channel modules.
DategetPubDate()
Returns the channel publishing date.
StringgetRating()
Returns the channel rating.
ListgetSkipDays()
Returns the channel skip days.
ListgetSkipHours()
Returns the channel skip hours.
TextInputgetTextInput()
Returns the channel text input.
StringgetTitle()
Returns the channel title.
intgetTtl()
Returns the channel time to live.
StringgetUri()
Returns the channel uri.
StringgetWebMaster()
Returns the channel web master.
voidsetCategories(List categories)
Sets the channel categories.
voidsetCloud(Cloud cloud)
Sets the channel cloud.
voidsetCopyright(String copyright)
Sets the channel copyright.
voidsetDescription(String description)
Sets the channel description.
voidsetDocs(String docs)
Sets the channel docs.
voidsetGenerator(String generator)
Sets the channel generator.
voidsetImage(Image image)
Sets the channel image.
voidsetItems(List items)
Sets the channel items.
voidsetLanguage(String language)
Sets the channel language.
voidsetLastBuildDate(Date lastBuildDate)
Sets the channel last build date.
voidsetLink(String link)
Sets the channel link.
voidsetManagingEditor(String managingEditor)
Sets the channel managing editor.
voidsetModules(List modules)
Sets the channel modules.
voidsetPubDate(Date pubDate)
Sets the channel publishing date.
voidsetRating(String rating)
Sets the channel rating.
voidsetSkipDays(List skipDays)
Sets the channel skip days.
voidsetSkipHours(List skipHours)
Sets the channel skip hours.
voidsetTextInput(TextInput textInput)
Sets the channel text input.
voidsetTitle(String title)
Sets the channel title.
voidsetTtl(int ttl)
Sets the channel time to live.
voidsetUri(String uri)
Sets the channel uri.
voidsetWebMaster(String webMaster)
Sets the channel web master.

Field Detail

DAYS

private static final Set DAYS

FRIDAY

public static final String FRIDAY

MONDAY

public static final String MONDAY

SATURDAY

public static final String SATURDAY

SUNDAY

public static final String SUNDAY

THURSDAY

public static final String THURSDAY

TUESDAY

public static final String TUESDAY

WEDNESDAY

public static final String WEDNESDAY

_categories

private List _categories

_cloud

private Cloud _cloud

_copyright

private String _copyright

_description

private String _description

_docs

private String _docs

_generator

private String _generator

_image

private Image _image

_items

private List _items

_language

private String _language

_lastBuildDate

private Date _lastBuildDate

_link

private String _link

_managingEditor

private String _managingEditor

_modules

private List _modules

_pubDate

private Date _pubDate

_rating

private String _rating

_skipDays

private List _skipDays

_skipHours

private List _skipHours

_textInput

private TextInput _textInput

_title

private String _title

_ttl

private int _ttl

_uri

private String _uri

_webMaster

private String _webMaster

Constructor Detail

Channel

public Channel()
Default constructor, for bean cloning purposes only.

Channel

public Channel(String type)
Channel Constructor. All properties, except the type, are set to null.

Parameters: type the type of the RSS feed.

Method Detail

getCategories

public List getCategories()
Returns the channel categories.

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

getCloud

public Cloud getCloud()
Returns the channel cloud.

Returns: the channel cloud, null if none.

getCopyright

public String getCopyright()
Returns the channel copyright.

Returns: the channel copyright, null if none.

getDescription

public String getDescription()
Returns the channel description.

Returns: the channel description, null if none.

getDocs

public String getDocs()
Returns the channel docs.

Returns: the channel docs, null if none.

getGenerator

public String getGenerator()
Returns the channel generator.

Returns: the channel generator, null if none.

getImage

public Image getImage()
Returns the channel image.

Returns: the channel image, null if none.

getItems

public List getItems()
Returns the channel items.

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

getLanguage

public String getLanguage()
Returns the channel language.

Returns: the channel language, null if none.

getLastBuildDate

public Date getLastBuildDate()
Returns the channel last build date.

Returns: the channel last build date, null if none.

getLink

public String getLink()
Returns the channel link.

Returns: the channel link, null if none.

getManagingEditor

public String getManagingEditor()
Returns the channel managing editor.

Returns: the channel managing editor, null if none.

getModule

public Module getModule(String uri)
Returns the module identified by a given URI.

Parameters: uri the URI of the ModuleImpl.

Returns: The module with the given URI, null if none.

getModules

public List getModules()
Returns the channel modules.

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

getPubDate

public Date getPubDate()
Returns the channel publishing date.

Returns: the channel publishing date, null if none.

getRating

public String getRating()
Returns the channel rating.

Returns: the channel rating, null if none.

getSkipDays

public List getSkipDays()
Returns the channel skip days.

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

getSkipHours

public List getSkipHours()
Returns the channel skip hours.

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

getTextInput

public TextInput getTextInput()
Returns the channel text input.

Returns: the channel text input, null if none.

getTitle

public String getTitle()
Returns the channel title.

Returns: the channel title, null if none.

getTtl

public int getTtl()
Returns the channel time to live.

Returns: the channel time to live, null if none.

getUri

public String getUri()
Returns the channel uri.

Returns: the channel uri, null if none.

getWebMaster

public String getWebMaster()
Returns the channel web master.

Returns: the channel web master, null if none.

setCategories

public void setCategories(List categories)
Sets the channel categories.

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

setCloud

public void setCloud(Cloud cloud)
Sets the channel cloud.

Parameters: cloud the channel cloud to set, null if none.

setCopyright

public void setCopyright(String copyright)
Sets the channel copyright.

Parameters: copyright the channel copyright to set, null if none.

setDescription

public void setDescription(String description)
Sets the channel description.

Parameters: description the channel description to set, null if none.

setDocs

public void setDocs(String docs)
Sets the channel docs.

Parameters: docs the channel docs to set, null if none.

setGenerator

public void setGenerator(String generator)
Sets the channel generator.

Parameters: generator the channel generator to set, null if none.

setImage

public void setImage(Image image)
Sets the channel image.

Parameters: image the channel image to set, null if none.

setItems

public void setItems(List items)
Sets the channel items.

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

setLanguage

public void setLanguage(String language)
Sets the channel language.

Parameters: language the channel language to set, null if none.

setLastBuildDate

public void setLastBuildDate(Date lastBuildDate)
Sets the channel last build date.

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

setLink

public void setLink(String link)
Sets the channel link.

Parameters: link the channel link to set, null if none.

setManagingEditor

public void setManagingEditor(String managingEditor)
Sets the channel managing editor.

Parameters: managingEditor the channel managing editor to set, null if none.

setModules

public void setModules(List modules)
Sets the channel modules.

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

setPubDate

public void setPubDate(Date pubDate)
Sets the channel publishing date.

Parameters: pubDate the channel publishing date to set, null if none.

setRating

public void setRating(String rating)
Sets the channel rating.

Parameters: rating the channel rating to set, null if none.

setSkipDays

public void setSkipDays(List skipDays)
Sets the channel skip days.

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

setSkipHours

public void setSkipHours(List skipHours)
Sets the channel skip hours.

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

setTextInput

public void setTextInput(TextInput textInput)
Sets the channel text input.

Parameters: textInput the channel text input to set, null if none.

setTitle

public void setTitle(String title)
Sets the channel title.

Parameters: title the channel title to set, null if none.

setTtl

public void setTtl(int ttl)
Sets the channel time to live.

Parameters: ttl the channel time to live to set, null if none.

setUri

public void setUri(String uri)
Sets the channel uri.

Parameters: uri the channel uri, null if none.

setWebMaster

public void setWebMaster(String webMaster)
Sets the channel web master.

Parameters: webMaster the channel web master to set, null if none.

Copyright © Sun Microsystems. All Rights Reserved.