org.apache.abdera.model
Interface Person

All Superinterfaces:
Base, java.lang.Cloneable, Element, ExtensibleElement

public interface Person
extends ExtensibleElement, Element

An Atom 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*)

 


Method Summary
 java.lang.String getEmail()
          The "atom:email" element's content conveys an e-mail address associated with the person.
 Element getEmailElement()
          The "atom:email" element's content conveys an e-mail address associated with the person.
 java.lang.String getName()
          The "atom:name" element's content conveys a human-readable name for the person.
 Element getNameElement()
          The "atom:name" element's content conveys a human-readable name for the person.
 IRI getUri()
          The "atom:uri" element's content conveys an IRI associated with the person.
 IRIElement getUriElement()
          The "atom:uri" element's content conveys an IRI associated with the person.
 Element setEmail(java.lang.String email)
          The "atom:email" element's content conveys an e-mail address associated with the person.
 void setEmailElement(Element element)
          The "atom:email" element's content conveys an e-mail address associated with the person.
 Element setName(java.lang.String name)
          The "atom:name" element's content conveys a human-readable name for the person.
 void setNameElement(Element element)
          The "atom:name" element's content conveys a human-readable name for the person.
 IRIElement setUri(java.lang.String uri)
          The "atom:uri" element's content conveys an IRI associated with the person.
 void setUriElement(IRIElement uri)
          The "atom:uri" element's content conveys an IRI associated with the person.
 
Methods inherited from interface org.apache.abdera.model.ExtensibleElement
addExtension, addExtension, addExtension, addSimpleExtension, addSimpleExtension, getExtension, getExtension, getExtensions, getExtensions, getExtensions, getSimpleExtension, getSimpleExtension
 
Methods inherited from interface org.apache.abdera.model.Element
declareNS, discard, getAttributes, getAttributeValue, getAttributeValue, getBaseUri, getDocument, getExtensionAttributes, getFirstChild, getFirstChild, getLanguage, getLanguageTag, getLocale, getNextSibling, getNextSibling, getParentElement, getPreviousSibling, getPreviousSibling, getQName, getResolvedBaseUri, getText, removeAttribute, setAttributeValue, setAttributeValue, setBaseUri, setBaseUri, setLanguage, setParentElement, setText
 
Methods inherited from interface org.apache.abdera.model.Base
addComment, clone, getFactory, writeTo, writeTo
 

Method Detail

getNameElement

Element getNameElement()
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:
The atom:name element

setNameElement

void setNameElement(Element 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.

Parameters:
element - The atom:name element

setName

Element setName(java.lang.String name)
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.

Parameters:
name - The person name
Returns:
The newly created atom:name element

getName

java.lang.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:
The name value

getEmailElement

Element getEmailElement()
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:
the atom:email element

setEmailElement

void setEmailElement(Element 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].

Parameters:
element - The atom:email element

setEmail

Element setEmail(java.lang.String email)
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].

Parameters:
email - The person email
Returns:
the newly created atom:email element

getEmail

java.lang.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:
the person's emali

getUriElement

IRIElement getUriElement()
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:
the atom:uri element

setUriElement

void setUriElement(IRIElement uri)
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].

Parameters:
uri - The atom:uri element

setUri

IRIElement setUri(java.lang.String uri)
                  throws IRISyntaxException
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].

Parameters:
uri - The atom:uri value
Throws:
IRISyntaxException - if the uri is malformed

getUri

IRI getUri()
           throws IRISyntaxException
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:
The atom:uri value
Throws:
IRISyntaxException - if the uri is invalid