com.helger.photon.basic.atom

Class FeedSource

java.lang.Object

com.helger.photon.basic.atom.AbstractFeedElement

com.helger.photon.basic.atom.FeedSource

All Implemented Interfaces:

IFeedElement

Direct Known Subclasses:

Feed

public class FeedSource
extends AbstractFeedElement

ATOM 1.0 feed source.

Author:

Philip Helger

Constructor Summary

Constructors

Constructor and Description
FeedSource()

Method Summary

Modifier and Type	Method and Description
void	addAuthor(FeedPerson aAuthor)
void	addCategory(FeedCategory aCategory)
void	addContributor(FeedPerson aContributor)
void	addLink(FeedLink aLink)
protected void	fillElement(com.helger.xml.microdom.IMicroElement aElement)
com.helger.xml.microdom.IMicroElement	getAsElement(String sElementName) Convert this news feed element to an MicroElement with the given element name.
com.helger.commons.collection.ext.ICommonsList<FeedPerson>	getAuthors()
com.helger.commons.collection.ext.ICommonsList<FeedCategory>	getCategories()
com.helger.commons.collection.ext.ICommonsList<FeedPerson>	getContributors()
FeedGenerator	getGenerator()
String	getIcon()
String	getID()
com.helger.commons.collection.ext.ICommonsList<FeedLink>	getLinks()
String	getLogo()
IFeedTextConstruct	getRights()
IFeedTextConstruct	getSubtitle()
IFeedTextConstruct	getTitle()
FeedDate	getUpdated()
boolean	isValid() Check if this element matches the specification.
void	setGenerator(FeedGenerator aGenerator)
void	setIcon(String sIcon)
void	setID(String sID)
void	setLogo(String sLogo)
void	setRights(IFeedTextConstruct aRights)
void	setSubtitle(IFeedTextConstruct aSubtitle)
void	setTitle(IFeedTextConstruct aTitle)
void	setUpdated(FeedDate aUpdated)

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

FeedSource

public FeedSource()

Method Detail

addAuthor

public final void addAuthor(@Nonnull
                            FeedPerson aAuthor)

getAuthors

@Nonnull
 @ReturnsMutableCopy
public final com.helger.commons.collection.ext.ICommonsList<FeedPerson> getAuthors()

addCategory

public final void addCategory(@Nonnull
                              FeedCategory aCategory)

getCategories

@Nonnull
 @ReturnsMutableCopy
public final com.helger.commons.collection.ext.ICommonsList<FeedCategory> getCategories()

addContributor

public final void addContributor(@Nonnull
                                 FeedPerson aContributor)

getContributors

@Nonnull
 @ReturnsMutableCopy
public final com.helger.commons.collection.ext.ICommonsList<FeedPerson> getContributors()

setGenerator

public final void setGenerator(@Nullable
                               FeedGenerator aGenerator)

getGenerator

@Nullable
public final FeedGenerator getGenerator()

setIcon

public final void setIcon(@Nullable
                          String sIcon)

getIcon

@Nullable
public final String getIcon()

setID

public final void setID(@Nullable
                        String sID)

getID

@Nullable
public final String getID()

addLink

public final void addLink(@Nonnull
                          FeedLink aLink)

getLinks

@Nonnull
 @ReturnsMutableCopy
public final com.helger.commons.collection.ext.ICommonsList<FeedLink> getLinks()

setLogo

public final void setLogo(@Nullable
                          String sLogo)

getLogo

@Nullable
public final String getLogo()

setRights

public final void setRights(@Nullable
                            IFeedTextConstruct aRights)

getRights

@Nullable
public final IFeedTextConstruct getRights()

setSubtitle

public final void setSubtitle(@Nullable
                              IFeedTextConstruct aSubtitle)

getSubtitle

@Nullable
public final IFeedTextConstruct getSubtitle()

setTitle

public final void setTitle(@Nullable
                           IFeedTextConstruct aTitle)

getTitle

@Nullable
public final IFeedTextConstruct getTitle()

setUpdated

public final void setUpdated(@Nullable
                             FeedDate aUpdated)

getUpdated

@Nullable
public final FeedDate getUpdated()

fillElement

protected final void fillElement(@Nonnull
                                 com.helger.xml.microdom.IMicroElement aElement)

getAsElement

@Nonnull
public com.helger.xml.microdom.IMicroElement getAsElement(@Nonnull @Nonempty
                                                                    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.

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.

Returns:

true if the element is valid, and false otherwise.