This project has retired. For details please refer to its Attic page.

org.apache.wink.common.model.atom
Class AtomPerson

java.lang.Object
  org.apache.wink.common.model.atom.AtomPerson

public class AtomPerson
extends Object

The Person construct Per RFC4287

 A Person construct is an element that describes a person, corporation, or similar entity
 (hereafter, 'person').
 
  atomPersonConstruct =
     atomCommonAttributes,
     (element atom:name { text }
      & element atom:uri { atomUri }?
      & element atom:email { atomEmailAddress }?
      & extensionElement*)
      
 This specification assigns no significance to the order of appearance of the child elements in a
 Person construct. Person constructs allow extension Metadata elements (see Section 6.4). 3.2.1
 The "atom:name" Element
 
 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.
 3.2.2 The "atom:uri" Element
 
 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]. 3.2.3 The "atom:email" Element
 
 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].
 

• The "atom:name" Element

   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.
   

• The "atom:uri" Element

   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].
   

• The "atom:email" Element

   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].
   

Field Summary

protected List<Element>	any
protected String	email
protected String	name
protected String	uri

Constructor Summary

AtomPerson()

AtomPerson(SyndPerson value)

Method Summary

List<Element>	getAny() Gets extension elements
String	getEmail() Gets the value of email.
String	getName() Gets the value of name.
String	getUri() Gets the value of uri.
void	setEmail(String value) Sets the value of email.
void	setName(String value) Sets the value of name.
void	setUri(String value) Sets the value of uri.
SyndPerson	toSynd(SyndPerson value)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

email

protected String email

any

protected List<Element> any

name

protected String name

uri

protected String uri

Constructor Detail

AtomPerson

public AtomPerson()

AtomPerson

public AtomPerson(SyndPerson value)

Method Detail

toSynd

public SyndPerson toSynd(SyndPerson value)

getEmail

public String getEmail()

Gets the value of email.

setEmail

public void setEmail(String value)

Sets the value of email.

getAny

public List<Element> getAny()

Gets extension elements

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the any.

For example, to add a new item, do as follows:

 getAny().add(newItem);
 

Objects of the following type(s) are allowed in the list Element

getName

public String getName()

Gets the value of name.

setName

public void setName(String value)

Sets the value of name.

getUri

public String getUri()

Gets the value of uri.

setUri

public void setUri(String value)

Sets the value of uri.