com.helger.photon.basic.atom

Class Feed

java.lang.Object

com.helger.photon.basic.atom.AbstractFeedElement

com.helger.photon.basic.atom.FeedSource

com.helger.photon.basic.atom.Feed

All Implemented Interfaces:

IFeedElement

public class Feed
extends FeedSource

Main ATOM 1.0 Feed

Author:

Philip Helger

Constructor Summary

Constructors

Constructor and Description
Feed()

Method Summary

Methods

Modifier and Type	Method and Description
Feed	addEntry(FeedEntry aEntry)
List<FeedEntry>	getAllEntries()
com.helger.commons.microdom.IMicroDocument	getAsDocument()
com.helger.commons.microdom.IMicroElement	getAsElement(String sElementName) Convert this news feed element to an MicroElement with the given element name.
int	getEntryCount()
boolean	isValid() Check if this element matches the specification.

Methods inherited from class com.helger.photon.basic.atom.FeedSource

addAuthor, addCategory, addContributor, addLink, fillElement, getAuthors, getCategories, getContributors, getGenerator, getIcon, getID, getLinks, getLogo, getRights, getSubtitle, getTitle, getUpdated, setGenerator, setIcon, setID, setLogo, setRights, setSubtitle, setTitle, setUpdated

Methods inherited from class com.helger.photon.basic.atom.AbstractFeedElement

getLanguage, setLanguage, setLanguage

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

addEntry

@Nonnull
public Feed addEntry(@Nonnull
                    FeedEntry aEntry)

getAllEntries

@Nonnull
@ReturnsMutableCopy
public List<FeedEntry> getAllEntries()

getEntryCount

@Nonnegative
public int getEntryCount()

getAsDocument

@Nonnull
public com.helger.commons.microdom.IMicroDocument getAsDocument()

getAsElement

public com.helger.commons.microdom.IMicroElement getAsElement(String sElementName)

Description copied from interface: IFeedElement

Convert this news feed element to an MicroElement with the given element name. In case this element is not valid according to IFeedElement.isValid() it should be safe anyway to create an element.

Specified by:

getAsElement in interface IFeedElement

Overrides:

getAsElement in class FeedSource

Parameters:

sElementName - The element name to use. May neither be null nor empty.

Returns:

The created IMicroElement and never null.

isValid

public boolean isValid()

Description copied from interface: IFeedElement

Check if this element matches the specification. This check method should only be called once the feed is assembled completely since there are interdependencies between the main feed and its entries.

Specified by:

isValid in interface IFeedElement

Overrides:

isValid in class FeedSource

Returns:

true if the element is valid, and false otherwise.