com.helger.photon.basic.atom

Class FeedGenerator

java.lang.Object

com.helger.photon.basic.atom.AbstractFeedElement

com.helger.photon.basic.atom.FeedGenerator

All Implemented Interfaces:

com.helger.commons.name.IHasDescription, IFeedElement

public class FeedGenerator
extends AbstractFeedElement
implements com.helger.commons.name.IHasDescription

Represents the generator of a feed.

Author:

Philip Helger

Constructor Summary

Constructors

Constructor and Description
FeedGenerator()
FeedGenerator(String sURI)

Method Summary

Methods

Modifier and Type	Method and Description
com.helger.commons.microdom.IMicroElement	getAsElement(String sElementName) Convert this news feed element to an MicroElement with the given element name.
String	getDescription()
String	getURI() The atom:generator element MAY have a "uri" attribute whose value MUST be an IRI reference [RFC3987].
String	getVersion() The atom:generator element MAY have a "version" attribute that indicates the version of the generating agent.
boolean	isValid() Check if this element matches the specification.
void	setDescription(String sDescription)
void	setURI(String sURI)
void	setVersion(String sVersion)

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

FeedGenerator

public FeedGenerator()

FeedGenerator

public FeedGenerator(@Nullable
             String sURI)

Method Detail

setURI

public void setURI(@Nullable
          String sURI)

getURI

@Nullable
public String getURI()

The atom:generator element MAY have a "uri" attribute whose value MUST be an IRI reference [RFC3987]. When dereferenced, the resulting URI (mapped from an IRI, if necessary) SHOULD produce a representation that is relevant to that agent.

Returns:

URI

setVersion

public void setVersion(@Nullable
              String sVersion)

getVersion

@Nullable
public String getVersion()

The atom:generator element MAY have a "version" attribute that indicates the version of the generating agent.

Returns:

version

setDescription

public void setDescription(@Nullable
                  String sDescription)

getDescription

@Nullable
public String getDescription()

Specified by:

getDescription in interface com.helger.commons.name.IHasDescription

getAsElement

@Nonnull
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

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

Returns:

true if the element is valid, and false otherwise.