com.helger.photon.basic.atom

Class FeedEntry

java.lang.Object

com.helger.photon.basic.atom.AbstractFeedElement

com.helger.photon.basic.atom.FeedEntry

All Implemented Interfaces:

IFeedElement

public class FeedEntry
extends AbstractFeedElement

Represents a single entry within an ATOM 1.0 feed.
Specs: http://atompub.org/rfc4287.html#element.entry

Author:

Philip Helger

Constructor Summary

Constructors

Constructor and Description
FeedEntry()

Method Summary

Modifier and Type	Method and Description
void	addAuthor(FeedPerson aAuthor)
void	addCategory(FeedCategory aCategory)
void	addContributor(FeedPerson aContributor)
void	addLink(FeedLink aLink)
List<FeedPerson>	getAllAuthors()
List<FeedCategory>	getAllCategories()
List<FeedPerson>	getAllContributors()
List<FeedLink>	getAllLinks()
com.helger.commons.microdom.IMicroElement	getAsElement(String sElementName) Convert this news feed element to an MicroElement with the given element name.
IFeedContent	getContent()
com.helger.commons.url.ISimpleURL	getID()
FeedDate	getPublished()
IFeedTextConstruct	getRights()
FeedSource	getSource()
IFeedTextConstruct	getSummary()
IFeedTextConstruct	getTitle()
FeedDate	getUpdated()
boolean	isValid() Check if this element matches the specification.
void	setContent(IFeedContent aContent)
void	setID(com.helger.commons.url.ISimpleURL aID)
void	setPublished(FeedDate aPublished)
void	setRights(IFeedTextConstruct aRights)
void	setSource(FeedSource aSource)
void	setSummary(IFeedTextConstruct aSummary)
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

FeedEntry

public FeedEntry()

Method Detail

addAuthor

public void addAuthor(@Nonnull
                      FeedPerson aAuthor)

getAllAuthors

@Nonnull
 @ReturnsMutableCopy
public List<FeedPerson> getAllAuthors()

addCategory

public void addCategory(@Nonnull
                        FeedCategory aCategory)

getAllCategories

@Nonnull
 @ReturnsMutableCopy
public List<FeedCategory> getAllCategories()

setContent

public void setContent(@Nullable
                       IFeedContent aContent)

getContent

@Nullable
public IFeedContent getContent()

addContributor

public void addContributor(@Nonnull
                           FeedPerson aContributor)

getAllContributors

@Nonnull
 @ReturnsMutableCopy
public List<FeedPerson> getAllContributors()

setID

public void setID(@Nullable
                  com.helger.commons.url.ISimpleURL aID)

getID

@Nullable
public com.helger.commons.url.ISimpleURL getID()

addLink

public void addLink(@Nonnull
                    FeedLink aLink)

getAllLinks

@Nonnull
 @ReturnsMutableCopy
public List<FeedLink> getAllLinks()

setPublished

public void setPublished(@Nullable
                         FeedDate aPublished)

getPublished

@Nullable
public FeedDate getPublished()

setRights

public void setRights(@Nullable
                      IFeedTextConstruct aRights)

getRights

@Nullable
public IFeedTextConstruct getRights()

setSource

public void setSource(@Nullable
                      FeedSource aSource)

getSource

@Nullable
public FeedSource getSource()

setSummary

public void setSummary(@Nullable
                       IFeedTextConstruct aSummary)

getSummary

@Nullable
public IFeedTextConstruct getSummary()

setTitle

public void setTitle(@Nullable
                     IFeedTextConstruct aTitle)

getTitle

@Nullable
public IFeedTextConstruct getTitle()

setUpdated

public void setUpdated(@Nullable
                       FeedDate aUpdated)

getUpdated

@Nullable
public FeedDate getUpdated()

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.

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.