christophedelory.atom
Class Feed

java.lang.Object
  christophedelory.atom.Common
      christophedelory.atom.Source
          christophedelory.atom.Feed

public class Feed
extends Source

An Atom Feed Document is a representation of an Atom feed, including metadata about the feed, and some or all of the entries associated with it. This element is the document (i.e., top-level) element of an Atom Feed Document, acting as a container for metadata and data associated with the feed. Its element children consist of metadata elements followed by zero or more entry child elements.

Version:

$Revision: 92 $

Author:

Christophe Delory

Constructor Summary

Feed()

Method Summary

void	addEntry(Entry entry) Adds a feed's entry.
List<Entry>	getEntries() Returns the list of feed's entries.
void	setId(URIContainer id) Initializes the permanent, universally unique identifier for the feed.
void	setTitle(TextContainer title) Initializes the human-readable title for this feed.
void	setUpdated(Date updated) Initializes the most recent instant in time when this feed was modified in a way the publisher considers significant.

Methods inherited from class christophedelory.atom.Source

addAuthor, addCategory, addContributor, addLink, getAuthors, getCategories, getContributors, getGenerator, getIcon, getId, getLinks, getLogo, getRights, getSubtitle, getTitle, getUpdated, setGenerator, setIcon, setLogo, setRights, setSubtitle

Methods inherited from class christophedelory.atom.Common

getBaseString, getLang, setBaseString, setLang

Methods inherited from class java.lang.Object

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

Constructor Detail

Feed

public Feed()

Method Detail

setId

public void setId(URIContainer id)

Description copied from class: Source

Initializes the permanent, universally unique identifier for the feed.

Overrides:

setId in class Source

Parameters:

id - an URI container. Shall not be null.

Throws:

NullPointerException - if id is null.

See Also:

Source.getId()

setTitle

public void setTitle(TextContainer title)

Description copied from class: Source

Initializes the human-readable title for this feed.

Overrides:

setTitle in class Source

Parameters:

title - a text container. Shall not be null.

Throws:

NullPointerException - if title is null.

See Also:

Source.getTitle()

setUpdated

public void setUpdated(Date updated)

Description copied from class: Source

Initializes the most recent instant in time when this feed was modified in a way the publisher considers significant.

Overrides:

setUpdated in class Source

Parameters:

updated - a date. Shall not be null.

Throws:

NullPointerException - if updated is null.

See Also:

Source.getUpdated()

getEntries

public List<Entry> getEntries()

Returns the list of feed's entries. The list is initially empty.

Returns:

a list of entries. May be empty but not null.

See Also:

addEntry(christophedelory.atom.Entry)

addEntry

public void addEntry(Entry entry)

Adds a feed's entry.

Parameters:

entry - an entry. Shall not be null.

Throws:

NullPointerException - if entry is null.

See Also:

getEntries()