com.helger.photon.basic.atom

Class FeedPerson

java.lang.Object

com.helger.photon.basic.atom.AbstractFeedElement

com.helger.photon.basic.atom.FeedPerson

All Implemented Interfaces:

IFeedElement

public class FeedPerson
extends AbstractFeedElement

Represents a person within a feed.

Author:

Philip Helger

Constructor Summary

Constructors

Constructor and Description
FeedPerson(String sName)

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	getEmail() The "atom:email" element's content conveys an e-mail address associated with the person.
String	getName() The "atom:name" element's content conveys a human-readable name for the person.
String	getURI() The "atom:uri" element's content conveys an IRI associated with the person.
boolean	isValid() Check if this element matches the specification.
void	setEmail(String sEmail)
void	setName(String sName)
void	setURI(String sURI)

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

FeedPerson

public FeedPerson(@Nullable
                  String sName)

Method Detail

setName

public void setName(@Nullable
                    String sName)

getName

@Nullable
public String getName()

The "atom:name" element's content conveys a human-readable name for the person. The content of atom:name is Language-Sensitive. Person constructs MUST contain exactly one "atom:name" element.

Returns:

name

setURI

public void setURI(@Nullable
                   String sURI)

getURI

@Nullable
public String getURI()

The "atom:uri" element's content conveys an IRI associated with the person. Person constructs MAY contain an atom:uri element, but MUST NOT contain more than one. The content of atom:uri in a Person construct MUST be an IRI reference [RFC3987].

Returns:

URI

setEmail

public void setEmail(@Nullable
                     String sEmail)

getEmail

@Nullable
public String getEmail()

The "atom:email" element's content conveys an e-mail address associated with the person. Person constructs MAY contain an atom:email element, but MUST NOT contain more than one. Its content MUST conform to the "addr-spec" production in [RFC2822].

Returns:

email

getAsElement

public com.helger.xml.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.