com.helger.photon.basic.atom

Interface IFeedElement

All Known Subinterfaces:

IFeedContent, IFeedTextConstruct

All Known Implementing Classes:

AbstractFeedElement, AbstractFeedText, AbstractFeedXHTML, Feed, FeedCategory, FeedDate, FeedEntry, FeedGenerator, FeedLink, FeedOtherContent, FeedOutOfLineContent, FeedPerson, FeedPlainTextConstruct, FeedSource, FeedTextContent, FeedXHTMLContent, FeedXHTMLTextConstruct

public interface IFeedElement

Base interface for all ATOM feeds

Author:

Philip Helger

Method Summary

Modifier and Type	Method and Description
com.helger.xml.microdom.IMicroElement	getAsElement(String sElementName) Convert this news feed element to an MicroElement with the given element name.
String	getLanguage() Any element defined by this specification MAY have an xml:lang attribute, whose content indicates the natural language for the element and its descendants.
boolean	isValid() Check if this element matches the specification.
void	setLanguage(Locale aContentLocale) Set the language for this element.
void	setLanguage(String sContentLanguage) Set the language for this element.

Method Detail

getLanguage

@Nullable
String getLanguage()

Any element defined by this specification MAY have an xml:lang attribute, whose content indicates the natural language for the element and its descendants. The language context is only significant for elements and attributes declared to be "Language-Sensitive" by this specification. Requirements regarding the content and interpretation of xml:lang are specified in XML 1.0 [W3C.REC-xml-20040204], Section 2.12.

Returns:

null or the current language

setLanguage

void setLanguage(@Nullable
                 Locale aContentLocale)

Set the language for this element.

Parameters:

aContentLocale - The language to set. May be null.

setLanguage

void setLanguage(@Nullable
                 String sContentLanguage)

Set the language for this element.

Parameters:

sContentLanguage - The language to set. May be null.

getAsElement

@Nonnull
com.helger.xml.microdom.IMicroElement getAsElement(String sElementName)

Convert this news feed element to an MicroElement with the given element name. In case this element is not valid according to 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

boolean isValid()

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.