org.apache.abdera.parser.stax
Class FOMEntry

java.lang.Object
  org.apache.axiom.om.impl.llom.OMNodeImpl
      org.apache.axiom.om.impl.llom.OMElementImpl
          org.apache.abdera.parser.stax.FOMElement
              org.apache.abdera.parser.stax.FOMExtensibleElement
                  org.apache.abdera.parser.stax.FOMEntry

All Implemented Interfaces:

Cloneable, Iterable<Element>, Base, Element, Entry, ExtensibleElement, Constants, org.apache.axiom.om.impl.OMContainerEx, org.apache.axiom.om.impl.OMNodeEx, org.apache.axiom.om.OMConstants, org.apache.axiom.om.OMContainer, org.apache.axiom.om.OMElement, org.apache.axiom.om.OMNode

public class FOMEntry
extends FOMExtensibleElement
implements Entry

Field Summary

Fields inherited from class org.apache.axiom.om.impl.llom.OMElementImpl

attributes, DEFAULT_DEFAULT_NS_OBJECT, firstChild, lastChild, localName, namespaces, noPrefixNamespaceCounter, ns, qName

Fields inherited from class org.apache.axiom.om.impl.llom.OMNodeImpl

builder, done, factory, nextSibling, nodeType, parent, previousSibling

Fields inherited from interface org.apache.axiom.om.OMNode

CDATA_SECTION_NODE, COMMENT_NODE, DTD_NODE, ELEMENT_NODE, ENTITY_REFERENCE_NODE, PI_NODE, SPACE_NODE, TEXT_NODE

Fields inherited from interface org.apache.abdera.util.Constants

ACCEPT, AID, ALTERNATE, APP_MEDIA_TYPE, APP_NS, APP_NS_PRE_RFC, APP_PREFIX, ATITLE, ATOM_MEDIA_TYPE, ATOM_NS, AURI, AUTHOR, BASE, CAT_MEDIA_TYPE, CATEGORIES, CATEGORY, CLASS, COLLECTION, CONFIG_FACTORY, CONFIG_PARSER, CONFIG_PARSERFACTORY, CONFIG_STREAMWRITER, CONFIG_WRITER, CONFIG_WRITERFACTORY, CONFIG_XPATH, CONTENT, CONTRIBUTOR, CONTROL, CONTROL_NS, CONTROL_PREFIX, DEFAULT_FACTORY, DEFAULT_PARSER, DEFAULT_PARSERFACTORY, DEFAULT_STREAMWRITER, DEFAULT_WRITER, DEFAULT_WRITERFACTORY, DEFAULT_XPATH, DIV, DRAFT, EDITED, EMAIL, ENTRY, ENTRY_MEDIA_TYPE, FEED, FEED_MEDIA_TYPE, FIXED, GENERATOR, HREF, HREFLANG, HTML, ICON, ID, LABEL, LANG, LENGTH, LINK, LN_ACCEPT, LN_ALTERNATE, LN_ALTERNATE_MULTIPART_RELATED, LN_AUTHOR, LN_BASE, LN_CATEGORIES, LN_CATEGORY, LN_CLASS, LN_COLLECTION, LN_CONTENT, LN_CONTRIBUTOR, LN_CONTROL, LN_DIV, LN_DRAFT, LN_EDITED, LN_EMAIL, LN_ENTRY, LN_FEED, LN_FIXED, LN_GENERATOR, LN_HREF, LN_HREFLANG, LN_ICON, LN_ID, LN_LABEL, LN_LANG, LN_LENGTH, LN_LINK, LN_LOGO, LN_NAME, LN_PUBLISHED, LN_REL, LN_RIGHTS, LN_SCHEME, LN_SERVICE, LN_SOURCE, LN_SPACE, LN_SRC, LN_SUBTITLE, LN_SUMMARY, LN_TERM, LN_TITLE, LN_TYPE, LN_UPDATED, LN_URI, LN_VERSION, LN_WORKSPACE, LOGO, MULTIPART_RELATED_TYPE, NAME, NAMED_PARSER, NAMED_WRITER, NO, PRE_RFC_ACCEPT, PRE_RFC_CATEGORIES, PRE_RFC_COLLECTION, PRE_RFC_CONTROL, PRE_RFC_DRAFT, PRE_RFC_EDITED, PRE_RFC_SERVICE, PRE_RFC_WORKSPACE, PREFIX, PREFIXED_TITLE, PUBLISHED, REL, RIGHTS, SCHEME, SERVICE, SOURCE, SPACE, SRC, STREAM_WRITER, SUBTITLE, SUMMARY, TERM, TEXT, TITLE, TYPE, UPDATED, URI, VERSION, WORKSPACE, XHTML, XHTML_NS, XML, XML_MEDIA_TYPE, XML_NS, YES

Fields inherited from interface org.apache.axiom.om.OMConstants

ARRAY_ITEM_LOCALNAME, ARRAY_ITEM_NS_PREFIX, ARRAY_ITEM_NSURI, ARRAY_ITEM_QNAME, DATA_HANDLER, DEFAULT_CHAR_SET_ENCODING, DEFAULT_DEFAULT_NAMESPACE, DEFAULT_XML_VERSION, IS_BINARY, IS_DATA_HANDLERS_AWARE, PULL_TYPE_BUILDER, PUSH_TYPE_BUILDER, XMLATTRTYPE_CDATA, XMLATTRTYPE_ENTITIES, XMLATTRTYPE_ENTITY, XMLATTRTYPE_ID, XMLATTRTYPE_IDREF, XMLATTRTYPE_IDREFS, XMLATTRTYPE_NMTOKEN, XMLATTRTYPE_NMTOKENS, XMLATTRTYPE_NOTATION, XMLNS_NS_PREFIX, XMLNS_NS_URI, XMLNS_PREFIX, XMLNS_URI

Constructor Summary

	FOMEntry()
protected	FOMEntry(org.apache.axiom.om.OMContainer parent, org.apache.axiom.om.OMFactory factory)
protected	FOMEntry(org.apache.axiom.om.OMContainer parent, org.apache.axiom.om.OMFactory factory, org.apache.axiom.om.OMXMLParserWrapper builder)
protected	FOMEntry(QName qname, org.apache.axiom.om.OMContainer parent, org.apache.axiom.om.OMFactory factory)
protected	FOMEntry(QName qname, org.apache.axiom.om.OMContainer parent, org.apache.axiom.om.OMFactory factory, org.apache.axiom.om.OMXMLParserWrapper builder)
protected	FOMEntry(String name, org.apache.axiom.om.OMNamespace namespace, org.apache.axiom.om.OMContainer parent, org.apache.axiom.om.OMFactory factory)

Method Summary

Entry	addAuthor(Person person) Adds an individual author to the entry
Person	addAuthor(String name) Adds an author
Person	addAuthor(String name, String email, String uri) Adds an author
Entry	addCategory(Category category) Adds an individual category to the entry
Category	addCategory(String term) Adds a category to the entry
Category	addCategory(String scheme, String term, String label) Adds a category to the entry
Entry	addContributor(Person person) Adds an individual contributor to this entry
Person	addContributor(String name) Adds a contributor
Person	addContributor(String name, String email, String uri) Adds an author
Control	addControl()
Entry	addLink(Link link) Adds an individual link to the entry
Link	addLink(String href) Add a link to the entry
Link	addLink(String href, String rel) Add a link to the entry
Link	addLink(String href, String rel, String type, String title, String hreflang, long length) Add a link to the entry
Link	getAlternateLink() Returns this entries first alternate link
Link	getAlternateLink(String type, String hreflang) Returns the first alternate link matching the specified type and hreflang
IRI	getAlternateLinkResolvedHref() Return a link href resolved against the in-scope Base URI
IRI	getAlternateLinkResolvedHref(String type, String hreflang) Return a link href resolved against the in-scope Base URI
Person	getAuthor() Returns the first author listed for the entry
List<Person>	getAuthors() Returns the complete set of authors listed for the entry
List<Category>	getCategories() Lists the complete set of categories listed for the entry
List<Category>	getCategories(String scheme) Lists the complete set of categories using the specified scheme A listing of atom:category elements using the specified scheme
String	getContent() Returns the text of the content element
Content	getContentElement() Returns the content for this entry
javax.activation.MimeType	getContentMimeType() Returns the media type of the content type or null if type equals 'text', 'html' or 'xhtml'
IRI	getContentSrc() Returns the content/@src attribute, if any
InputStream	getContentStream() Returns an input stream from the content element value.
Content.Type	getContentType() Returns the content type
List<Person>	getContributors() Lists the complete set of contributors for this entry
Control	getControl() Returns this entries Atom Publishing Protocol control element
Control	getControl(boolean create) Returns this entries Atom Publishing Protocol control element.
Date	getEdited() Return the value of app:edited
DateTime	getEditedElement() APP Introduces a new app:edited element whose value changes every time the entry is updated
Link	getEditLink() Returns this entries first edit link
IRI	getEditLinkResolvedHref() Return a link href resolved against the in-scope Base URI
Link	getEditMediaLink() Returns this entries first edit-media link (if any)
Link	getEditMediaLink(String type, String hreflang) Returns the first edit-media link matching the specified type and hreflang
IRI	getEditMediaLinkResolvedHref() Return a link href resolved against the in-scope Base URI
IRI	getEditMediaLinkResolvedHref(String type, String hreflang) Return a link href resolved against the in-scope Base URI
Link	getEnclosureLink() Returns this entries first enclosure link
IRI	getEnclosureLinkResolvedHref() Return a link href resolved against the in-scope Base URI
IRI	getId() Returns the universally unique identifier for this entry
IRIElement	getIdElement() Returns the universally unique identifier for this entry
Link	getLink(String rel) Returns the first link with the specified rel attribute value
IRI	getLinkResolvedHref(String rel) Return a link href resolved against the in-scope Base URI
List<Link>	getLinks() Lists the complete set of links for this entry
List<Link>	getLinks(String... rels) Lists the complete set of links using the specified rel attributes values
List<Link>	getLinks(String rel) Lists the complete set of links using the specified rel attribute value
Date	getPublished() Return the value of the atom:published element
DateTime	getPublishedElement() RFC4287: The "atom:published" element is a Date construct indicating an instant in time associated with an event early in the life cycle of the entry...
String	getRights() Return the String value of the atom:rights element
Text	getRightsElement() The rights element is typically used to convey a human readable copyright (e.g.
Text.Type	getRightsType() Return the @type of the atom:rights element
Link	getSelfLink() Returns this entries first self link
IRI	getSelfLinkResolvedHref() Return a link href resolved against the in-scope Base URI
Source	getSource() Returns the source element for this entry.
String	getSummary() Returns the text string value of this summary
Text	getSummaryElement() RFC4287: The "atom:summary" element is a Text construct that conveys a short summary, abstract, or excerpt of an entry...
Text.Type	getSummaryType() Returns the summary type
String	getTitle() Returns the text string value of the title element
Text	getTitleElement() RFC4287: The "atom:title" element is a Text construct that conveys a human-readable title for an entry or feed.
Text.Type	getTitleType() Returns the @type of this entries title
Date	getUpdated() Return atom:updated
DateTime	getUpdatedElement() RFC4287: The "atom:updated" element is a Date construct indicating the most recent instant in time when an entry or feed was modified in a way the publisher considers significant.
boolean	isDraft() Returns true if this entry is a draft
IRIElement	newId() Creates a new randomized atom:id for the entry
Content	setContent(javax.activation.DataHandler dataHandler) Sets the content for this entry
Content	setContent(javax.activation.DataHandler dataHandler, String mediatype) Sets the content for this entry
Content	setContent(Element value) Sets the content for this entry
Content	setContent(Element element, String mediaType) Sets the content for this entry
Content	setContent(InputStream in) Sets the content for this entry
Content	setContent(InputStream in, String mediatype) Sets the content for this entry
Content	setContent(IRI uri, String mediatype) Sets the content for this entry
Content	setContent(String value) Sets the content for this entry as @type="text"
Content	setContent(String value, Content.Type type) Sets the content for this entry
Content	setContent(String value, String mediatype) Sets the content for this entry
Content	setContentAsHtml(String value) Sets the content for this entry as @type="html"
Content	setContentAsXhtml(String value) Sets the content for this entry as @type="xhtml"
Entry	setContentElement(Content content) Sets the content for this entry
Entry	setControl(Control control) Sets this entries Atom Publishing Protocol control element
Entry	setDraft(boolean draft) Sets whether or not this entry is a draft
DateTime	setEdited(Date value) Set the value of app:edited
DateTime	setEdited(String value) Set the value of app:edited
void	setEditedElement(DateTime updated) Set the app:edited element
IRIElement	setId(String value) Sets the universally unique identifier for this entry
IRIElement	setId(String value, boolean normalize) Sets the universally unique identifier for this entry
Entry	setIdElement(IRIElement id) Sets the universally unique identifier for this entry
DateTime	setPublished(Date value) Set the value of the atom:published element
DateTime	setPublished(String value) Set the value of the atom:published element using the serialized string value
Entry	setPublishedElement(DateTime dateTime) RFC4287: The "atom:published" element is a Date construct indicating an instant in time associated with an event early in the life cycle of the entry...
Text	setRights(Div value) Sets the value of the right as @type="xhtml"
Text	setRights(String value) Sets the value of the rights as @type="text"
Text	setRights(String value, Text.Type type) Sets the value of the rights
Text	setRightsAsHtml(String value) Sets the value of the rights as @type="html".
Text	setRightsAsXhtml(String value) Sets the value of the rights as @type="xhtml"
Entry	setRightsElement(Text text) The rights element is typically used to convey a human readable copyright (e.g.
Entry	setSource(Source source) Returns the source element for this entry.
Text	setSummary(Div value) Sets the value of the summary as @type="xhtml"
Text	setSummary(String value) Sets the value of the summary as @type="text"
Text	setSummary(String value, Text.Type type) Sets the value of the summary
Text	setSummaryAsHtml(String value) Sets the value of the summary as @type="html"
Text	setSummaryAsXhtml(String value) Sets the value of the summary as @type="xhtml"
Entry	setSummaryElement(Text text) RFC4287: The "atom:summary" element is a Text construct that conveys a short summary, abstract, or excerpt of an entry...
Text	setTitle(Div value) Sets the value of the title as @type="xhtml"
Text	setTitle(String value) Sets the value of the title as @type="text"
Text	setTitle(String value, Text.Type type) Sets the value of the title
Text	setTitleAsHtml(String value) Sets the value of the title as @type="html"
Text	setTitleAsXhtml(String value) Sets the value of the title as @type="xhtml"
Entry	setTitleElement(Text title) RFC4287: The "atom:title" element is a Text construct that conveys a human-readable title for an entry or feed.
DateTime	setUpdated(Date value) Set the atom:updated value
DateTime	setUpdated(String value) Set the atom:updated value
Entry	setUpdatedElement(DateTime updated) RFC4287: The "atom:updated" element is a Date construct indicating the most recent instant in time when an entry or feed was modified in a way the publisher considers significant.

Methods inherited from class org.apache.abdera.parser.stax.FOMExtensibleElement

addExtension, addExtension, addExtension, addExtension, addExtension, addExtensions, addSimpleExtension, addSimpleExtension, getExtension, getExtension, getExtensions, getExtensions, getExtensions, getSimpleExtension, getSimpleExtension

Methods inherited from class org.apache.abdera.parser.stax.FOMElement

_copyElement, _create, _getChildrenAsSet, _getElementValue, _getStringValue, _getUriValue, _parse, _removeAllChildren, _removeChildren, _resolve, _setChild, _setElementValue, addComment, clone, complete, declareIfNecessary, declareNS, getAttributes, getAttributeValue, getAttributeValue, getBaseUri, getDefaultWriterOptions, getDocument, getElements, getExtensionAttributes, getFactory, getFirstChild, getFirstChild, getLanguage, getLanguageTag, getLocale, getMustPreserveWhitespace, getNamespaces, getNextSibling, getNextSibling, getParentElement, getPreviousSibling, getPreviousSibling, getResolvedBaseUri, getText, getText, getTextElement, getWrapped, isDeclared, iterator, removeAttribute, removeAttribute, selectLink, setAttributeValue, setAttributeValue, setBaseUri, setBaseUri, setHtmlText, setLanguage, setMustPreserveWhitespace, setParentDocument, setParentElement, setText, setText, setTextElement, setTextText, setXhtmlText, setXhtmlText, toFormattedString, writeTo, writeTo, writeTo, writeTo, writeTo, writeTo, writeTo, writeTo, writeTo, writeTo, writeTo, writeTo

Methods inherited from class org.apache.axiom.om.impl.llom.OMElementImpl

addAttribute, addAttribute, addChild, build, buildNext, buildWithAttachments, cloneOMElement, declareDefaultNamespace, declareNamespace, declareNamespace, detach, discard, findNamespace, findNamespaceURI, getAllAttributes, getAllDeclaredNamespaces, getAttribute, getBuilder, getChildElements, getChildren, getChildrenWithLocalName, getChildrenWithName, getChildrenWithNamespaceURI, getDefaultNamespace, getFirstChildWithName, getFirstElement, getFirstOMChild, getLineNumber, getLocalName, getNamespace, getNextOMSibling, getQName, getTextAsQName, getTrimmedText, getType, getXMLStreamReader, getXMLStreamReaderWithoutCaching, internalSerialize, internalSerialize, internalSerializeAndConsume, isComplete, notifyChildComplete, removeAttribute, resolveQName, setBuilder, setFirstChild, setLastChild, setLineNumber, setLocalName, setNamespace, setNamespaceWithNoFindInCurrentScope, setText, toString, toStringWithConsume

Methods inherited from class org.apache.axiom.om.impl.llom.OMNodeImpl

close, getOMFactory, getParent, getPreviousOMSibling, importNode, insertSiblingAfter, insertSiblingBefore, serialize, serialize, serialize, serialize, serialize, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, setComplete, setNextOMSibling, setParent, setPreviousOMSibling, setType

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.abdera.model.ExtensibleElement

addExtension, addExtension, 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, getElements, getExtensionAttributes, getFirstChild, getFirstChild, getLanguage, getLanguageTag, getLocale, getMustPreserveWhitespace, getNamespaces, getNextSibling, getNextSibling, getParentElement, getPreviousSibling, getPreviousSibling, getQName, getResolvedBaseUri, getText, removeAttribute, removeAttribute, setAttributeValue, setAttributeValue, setBaseUri, setBaseUri, setLanguage, setMustPreserveWhitespace, setParentElement, setText, setText

Methods inherited from interface org.apache.abdera.model.Base

addComment, clone, complete, getDefaultWriterOptions, getFactory, writeTo, writeTo, writeTo, writeTo, writeTo, writeTo, writeTo, writeTo, writeTo, writeTo, writeTo, writeTo

Methods inherited from interface java.lang.Iterable

iterator

Methods inherited from interface org.apache.axiom.om.OMElement

addAttribute, addAttribute, cloneOMElement, declareDefaultNamespace, declareNamespace, declareNamespace, findNamespace, findNamespaceURI, getAllAttributes, getAllDeclaredNamespaces, getAttribute, getBuilder, getChildElements, getDefaultNamespace, getFirstElement, getLineNumber, getLocalName, getNamespace, getQName, getTextAsQName, getXMLStreamReader, getXMLStreamReaderWithoutCaching, removeAttribute, resolveQName, setBuilder, setFirstChild, setLineNumber, setLocalName, setNamespace, setNamespaceWithNoFindInCurrentScope, setText, toString, toStringWithConsume

Methods inherited from interface org.apache.axiom.om.OMNode

build, buildWithAttachments, close, detach, discard, getNextOMSibling, getOMFactory, getParent, getPreviousOMSibling, getType, insertSiblingAfter, insertSiblingBefore, isComplete, serialize, serialize, serialize, serialize, serialize, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume

Methods inherited from interface org.apache.axiom.om.OMContainer

addChild, buildNext, getChildren, getChildrenWithLocalName, getChildrenWithName, getChildrenWithNamespaceURI, getFirstChildWithName, getFirstOMChild, isComplete

Methods inherited from interface org.apache.axiom.om.impl.OMContainerEx

setComplete

Constructor Detail

FOMEntry

public FOMEntry()

FOMEntry

protected FOMEntry(String name,
                   org.apache.axiom.om.OMNamespace namespace,
                   org.apache.axiom.om.OMContainer parent,
                   org.apache.axiom.om.OMFactory factory)
            throws org.apache.axiom.om.OMException

Throws:

org.apache.axiom.om.OMException

FOMEntry

protected FOMEntry(QName qname,
                   org.apache.axiom.om.OMContainer parent,
                   org.apache.axiom.om.OMFactory factory)

FOMEntry

protected FOMEntry(QName qname,
                   org.apache.axiom.om.OMContainer parent,
                   org.apache.axiom.om.OMFactory factory,
                   org.apache.axiom.om.OMXMLParserWrapper builder)

FOMEntry

protected FOMEntry(org.apache.axiom.om.OMContainer parent,
                   org.apache.axiom.om.OMFactory factory)
            throws org.apache.axiom.om.OMException

Throws:

org.apache.axiom.om.OMException

FOMEntry

protected FOMEntry(org.apache.axiom.om.OMContainer parent,
                   org.apache.axiom.om.OMFactory factory,
                   org.apache.axiom.om.OMXMLParserWrapper builder)
            throws org.apache.axiom.om.OMException

Throws:

org.apache.axiom.om.OMException

Method Detail

getAuthor

public Person getAuthor()

Description copied from interface: Entry

Returns the first author listed for the entry

Specified by:

getAuthor in interface Entry

Returns:

The atom:author

getAuthors

public List<Person> getAuthors()

Description copied from interface: Entry

Returns the complete set of authors listed for the entry

Specified by:

getAuthors in interface Entry

Returns:

The listing of atom:author elements

addAuthor

public Entry addAuthor(Person person)

Description copied from interface: Entry

Adds an individual author to the entry

Specified by:

addAuthor in interface Entry

Parameters:

person - The person to add

addAuthor

public Person addAuthor(String name)

Description copied from interface: Entry

Adds an author

Specified by:

addAuthor in interface Entry

Parameters:

name - The name of the author

Returns:

The newly created atom:author element

addAuthor

public Person addAuthor(String name,
                        String email,
                        String uri)

Description copied from interface: Entry

Adds an author

Specified by:

addAuthor in interface Entry

Parameters:

name - The name of the author

email - The author's email address

uri - A URI belonging to the author

Returns:

The newly created atom:author element

getCategories

public List<Category> getCategories()

Description copied from interface: Entry

Lists the complete set of categories listed for the entry

Specified by:

getCategories in interface Entry

Returns:

The listing of atom:category elements

getCategories

public List<Category> getCategories(String scheme)

Description copied from interface: Entry

Lists the complete set of categories using the specified scheme A listing of atom:category elements using the specified scheme

Specified by:

getCategories in interface Entry

addCategory

public Entry addCategory(Category category)

Description copied from interface: Entry

Adds an individual category to the entry

Specified by:

addCategory in interface Entry

Parameters:

category - The atom:category element to add

addCategory

public Category addCategory(String term)

Description copied from interface: Entry

Adds a category to the entry

Specified by:

addCategory in interface Entry

Parameters:

term - The category term to add

Returns:

The newly created atom:category

addCategory

public Category addCategory(String scheme,
                            String term,
                            String label)

Description copied from interface: Entry

Adds a category to the entry

Specified by:

addCategory in interface Entry

Parameters:

scheme - The category scheme

term - The category term

label - The human readable label

Returns:

The newly create atom:category

getContentElement

public Content getContentElement()

Description copied from interface: Entry

Returns the content for this entry

Specified by:

getContentElement in interface Entry

Returns:

The atom:content element

setContentElement

public Entry setContentElement(Content content)

Description copied from interface: Entry

Sets the content for this entry

Specified by:

setContentElement in interface Entry

Parameters:

content - The atom:content element

setContent

public Content setContent(String value)

Sets the content for this entry as @type="text"

Specified by:

setContent in interface Entry

Parameters:

value - The text value of the content

Returns:

The newly created atom:content

setContentAsHtml

public Content setContentAsHtml(String value)

Description copied from interface: Entry

Sets the content for this entry as @type="html"

Specified by:

setContentAsHtml in interface Entry

Parameters:

value - The text value of the content. Special characters will be escaped (e.g. & will become &amp;)

Returns:

The newly created atom:content

setContentAsXhtml

public Content setContentAsXhtml(String value)

Description copied from interface: Entry

Sets the content for this entry as @type="xhtml"

Specified by:

setContentAsXhtml in interface Entry

Parameters:

value - The text value of the content. The text will be parsed as XHTML

Returns:

The newly created atom:content

setContent

public Content setContent(String value,
                          Content.Type type)

Sets the content for this entry

Specified by:

setContent in interface Entry

Parameters:

value - The text value of the content

type - The Content Type of the text

Returns:

The newly created atom:content

setContent

public Content setContent(Element value)

Sets the content for this entry

Specified by:

setContent in interface Entry

Parameters:

value - The content element value. If the value is a Div, the the type attribute will be set to type="xhtml", otherwise type="application/xml"

Returns:

The newly create atom:content

setContent

public Content setContent(Element element,
                          String mediaType)

Sets the content for this entry

Specified by:

setContent in interface Entry

Parameters:

element - The element value

mediaType - The media type of the element

Throws:

MimeTypeParseException

setContent

public Content setContent(javax.activation.DataHandler dataHandler)

Sets the content for this entry

Specified by:

setContent in interface Entry

Parameters:

dataHandler - The Data Handler containing the binary content needing Base64 encoding.

Throws:

MimeTypeParseException

setContent

public Content setContent(javax.activation.DataHandler dataHandler,
                          String mediatype)

Sets the content for this entry

Specified by:

setContent in interface Entry

Parameters:

dataHandler - The Data Handler containing the binary content needing Base64 encoding.

Returns:

The created content element

Throws:

MimeTypeParseException

setContent

public Content setContent(InputStream in)

Sets the content for this entry

Specified by:

setContent in interface Entry

Parameters:

in - An inputstream providing binary content

Returns:

The created content element

setContent

public Content setContent(InputStream in,
                          String mediatype)

Sets the content for this entry

Specified by:

setContent in interface Entry

Parameters:

in - An inputstream providing binary content

Returns:

The created content element

setContent

public Content setContent(String value,
                          String mediatype)

Sets the content for this entry

Specified by:

setContent in interface Entry

Parameters:

value - the string value of the content

mediatype - the media type for the content

Returns:

The newly created atom:content

Throws:

MimeTypeParseException

setContent

public Content setContent(IRI uri,
                          String mediatype)

Sets the content for this entry

Specified by:

setContent in interface Entry

Parameters:

uri - URI of the content (value of the "src" attribute).

mediatype - Type of the content.

Returns:

The new content element.

Throws:

MimeTypeParseException

IRISyntaxException

getContributors

public List<Person> getContributors()

Description copied from interface: Entry

Lists the complete set of contributors for this entry

Specified by:

getContributors in interface Entry

Returns:

The listing of atom:contributor elements

addContributor

public Entry addContributor(Person person)

Description copied from interface: Entry

Adds an individual contributor to this entry

Specified by:

addContributor in interface Entry

Parameters:

person - The atom:contributor element

addContributor

public Person addContributor(String name)

Description copied from interface: Entry

Adds a contributor

Specified by:

addContributor in interface Entry

Parameters:

name - The contributor name

Returns:

The newly created atom:contributor

addContributor

public Person addContributor(String name,
                             String email,
                             String uri)

Description copied from interface: Entry

Adds an author

Specified by:

addContributor in interface Entry

Parameters:

name - The contributor name

email - The contributor's email address

uri - The contributor's URI

Returns:

The newly created atom:contributor

getIdElement

public IRIElement getIdElement()

Description copied from interface: Entry

Returns the universally unique identifier for this entry

Specified by:

getIdElement in interface Entry

Returns:

The atom:id element

setIdElement

public Entry setIdElement(IRIElement id)

Description copied from interface: Entry

Sets the universally unique identifier for this entry

Specified by:

setIdElement in interface Entry

Parameters:

id - The atom:id element

getId

public IRI getId()

Description copied from interface: Entry

Returns the universally unique identifier for this entry

Specified by:

getId in interface Entry

setId

public IRIElement setId(String value)

Description copied from interface: Entry

Sets the universally unique identifier for this entry

Specified by:

setId in interface Entry

Parameters:

value - The atom:id value

Returns:

The newly created atom:id element

newId

public IRIElement newId()

Description copied from interface: Entry

Creates a new randomized atom:id for the entry

Specified by:

newId in interface Entry

setId

public IRIElement setId(String value,
                        boolean normalize)

Description copied from interface: Entry

Sets the universally unique identifier for this entry

Specified by:

setId in interface Entry

Parameters:

value - The atom:id value

normalize - true if the atom:id value should be normalized as called for by RFC4287

Returns:

The newly created atom:id element

getLinks

public List<Link> getLinks()

Description copied from interface: Entry

Lists the complete set of links for this entry

Specified by:

getLinks in interface Entry

Returns:

The listing of atom:link elements

getLinks

public List<Link> getLinks(String rel)

Description copied from interface: Entry

Lists the complete set of links using the specified rel attribute value

Specified by:

getLinks in interface Entry

Parameters:

rel - The rel attribute value to look for

Returns:

The listing of atom:link element's with the rel attribute

getLinks

public List<Link> getLinks(String... rels)

Description copied from interface: Entry

Lists the complete set of links using the specified rel attributes values

Specified by:

getLinks in interface Entry

Returns:

A listof atom:link elements

addLink

public Entry addLink(Link link)

Description copied from interface: Entry

Adds an individual link to the entry

Specified by:

addLink in interface Entry

Parameters:

link - the atom:link to add

addLink

public Link addLink(String href)

Description copied from interface: Entry

Add a link to the entry

Specified by:

addLink in interface Entry

Parameters:

href - The IRI of the link

Returns:

The newly created atom:link

addLink

public Link addLink(String href,
                    String rel)

Description copied from interface: Entry

Add a link to the entry

Specified by:

addLink in interface Entry

Parameters:

href - The IRI of the link

rel - The link rel attribute

Returns:

The newly created atom:link

addLink

public Link addLink(String href,
                    String rel,
                    String type,
                    String title,
                    String hreflang,
                    long length)

Description copied from interface: Entry

Add a link to the entry

Specified by:

addLink in interface Entry

Parameters:

href - The IRI of the link

rel - The link rel attribute

type - The media type of the link

hreflang - The language of the target

length - The length of the resource

Returns:

The newly created atom:link

getPublishedElement

public DateTime getPublishedElement()

Description copied from interface: Entry

RFC4287: The "atom:published" element is a Date construct indicating an instant in time associated with an event early in the life cycle of the entry... Typically, atom:published will be associated with the initial creation or first availability of the resource.

Specified by:

getPublishedElement in interface Entry

Returns:

The atom:published element

setPublishedElement

public Entry setPublishedElement(DateTime dateTime)

Description copied from interface: Entry

RFC4287: The "atom:published" element is a Date construct indicating an instant in time associated with an event early in the life cycle of the entry... Typically, atom:published will be associated with the initial creation or first availability of the resource.

Specified by:

setPublishedElement in interface Entry

Parameters:

dateTime - the atom:published element

getPublished

public Date getPublished()

Description copied from interface: Entry

Return the value of the atom:published element

Specified by:

getPublished in interface Entry

Returns:

a java.util.Date for the atom:published value

setPublished

public DateTime setPublished(Date value)

Description copied from interface: Entry

Set the value of the atom:published element

Specified by:

setPublished in interface Entry

Parameters:

value - The java.util.Date

Returns:

The newly created atom:published element

setPublished

public DateTime setPublished(String value)

Description copied from interface: Entry

Set the value of the atom:published element using the serialized string value

Specified by:

setPublished in interface Entry

Parameters:

value - The serialized date

Returns:

The newly created atom:published element

getRightsElement

public Text getRightsElement()

Description copied from interface: Entry

The rights element is typically used to convey a human readable copyright (e.g. "<atom:rights>Copyright (c), 2006</atom:rights>).

RFC4287: The "atom:rights" element is a Text construct that conveys information about rights held in and over an entry or feed.

Specified by:

getRightsElement in interface Entry

Returns:

The atom:rights element

setRightsElement

public Entry setRightsElement(Text text)

Description copied from interface: Entry

The rights element is typically used to convey a human readable copyright (e.g. "<atom:rights>Copyright (c), 2006</atom:rights>).

RFC4287: The "atom:rights" element is a Text construct that conveys information about rights held in and over an entry or feed.

Specified by:

setRightsElement in interface Entry

Parameters:

text - The atom:rights element

setRights

public Text setRights(String value)

Description copied from interface: Entry

Sets the value of the rights as @type="text"

Specified by:

setRights in interface Entry

Parameters:

value - The text value of the atom:rights element

Returns:

The newly created atom:rights element

setRightsAsHtml

public Text setRightsAsHtml(String value)

Description copied from interface: Entry

Sets the value of the rights as @type="html". Special characters like & will be automatically escaped

Specified by:

setRightsAsHtml in interface Entry

Parameters:

value - The text value of the atom:rights element.

Returns:

The newly created atom:rights element

setRightsAsXhtml

public Text setRightsAsXhtml(String value)

Description copied from interface: Entry

Sets the value of the rights as @type="xhtml"

Specified by:

setRightsAsXhtml in interface Entry

Parameters:

value - The text value of the atom:rights element

Returns:

The newly created atom:rights element

setRights

public Text setRights(String value,
                      Text.Type type)

Description copied from interface: Entry

Sets the value of the rights

Specified by:

setRights in interface Entry

Parameters:

value - The text value of the atom:rights element

type - The text type

Returns:

The newly create atom:rights element

setRights

public Text setRights(Div value)

Description copied from interface: Entry

Sets the value of the right as @type="xhtml"

Specified by:

setRights in interface Entry

Parameters:

value - The XHTML div for the atom:rights element

Returns:

The newly created atom:rights element

getRights

public String getRights()

Description copied from interface: Entry

Return the String value of the atom:rights element

Specified by:

getRights in interface Entry

Returns:

The text value of the atom:rights element

getSource

public Source getSource()

Description copied from interface: Entry

Returns the source element for this entry.

RFC4287: If an atom:entry is copied from one feed into another feed, then the source atom:feed's metadata (all child elements of atom:feed other than the atom:entry elements) MAY be preserved within the copied entry by adding an atom:source child element, if it is not already present in the entry, and including some or all of the source feed's Metadata elements as the atom:source element's children. Such metadata SHOULD be preserved if the source atom:feed contains any of the child elements atom:author, atom:contributor, atom:rights, or atom:category and those child elements are not present in the source atom:entry.

Specified by:

getSource in interface Entry

Returns:

The atom:source element

setSource

public Entry setSource(Source source)

Description copied from interface: Entry

Returns the source element for this entry.

RFC4287: If an atom:entry is copied from one feed into another feed, then the source atom:feed's metadata (all child elements of atom:feed other than the atom:entry elements) MAY be preserved within the copied entry by adding an atom:source child element, if it is not already present in the entry, and including some or all of the source feed's Metadata elements as the atom:source element's children. Such metadata SHOULD be preserved if the source atom:feed contains any of the child elements atom:author, atom:contributor, atom:rights, or atom:category and those child elements are not present in the source atom:entry.

Specified by:

setSource in interface Entry

Parameters:

source - The atom:source element

getSummaryElement

public Text getSummaryElement()

Description copied from interface: Entry

RFC4287: The "atom:summary" element is a Text construct that conveys a short summary, abstract, or excerpt of an entry... It is not advisable for the atom:summary element to duplicate atom:title or atom:content because Atom Processors might assume there is a useful summary when there is none.

Specified by:

getSummaryElement in interface Entry

Returns:

The atom:summary element

setSummaryElement

public Entry setSummaryElement(Text text)

Description copied from interface: Entry

RFC4287: The "atom:summary" element is a Text construct that conveys a short summary, abstract, or excerpt of an entry... It is not advisable for the atom:summary element to duplicate atom:title or atom:content because Atom Processors might assume there is a useful summary when there is none.

Specified by:

setSummaryElement in interface Entry

Parameters:

text - The atom:summary element

setSummary

public Text setSummary(String value)

Description copied from interface: Entry

Sets the value of the summary as @type="text"

Specified by:

setSummary in interface Entry

Parameters:

value - The text value of the atom:summary element

Returns:

the newly created atom:summary element

setSummaryAsHtml

public Text setSummaryAsHtml(String value)

Description copied from interface: Entry

Sets the value of the summary as @type="html"

Specified by:

setSummaryAsHtml in interface Entry

Parameters:

value - The text value of the atom:summary element

Returns:

the newly created atom:summary element

setSummaryAsXhtml

public Text setSummaryAsXhtml(String value)

Description copied from interface: Entry

Sets the value of the summary as @type="xhtml"

Specified by:

setSummaryAsXhtml in interface Entry

Parameters:

value - The text value of the atom:summary element

Returns:

the newly created atom:summary element

setSummary

public Text setSummary(String value,
                       Text.Type type)

Description copied from interface: Entry

Sets the value of the summary

Specified by:

setSummary in interface Entry

Parameters:

value - The text value of the atom:summary element

type - The Text.Type of the atom:summary element

Returns:

The newly created atom:summary element

setSummary

public Text setSummary(Div value)

Description copied from interface: Entry

Sets the value of the summary as @type="xhtml"

Specified by:

setSummary in interface Entry

Parameters:

value - The XHTML div

Returns:

the newly created atom:summary element

getSummary

public String getSummary()

Description copied from interface: Entry

Returns the text string value of this summary

Specified by:

getSummary in interface Entry

Returns:

the text value of the atom:summary

getTitleElement

public Text getTitleElement()

Description copied from interface: Entry

RFC4287: The "atom:title" element is a Text construct that conveys a human-readable title for an entry or feed.

Specified by:

getTitleElement in interface Entry

Returns:

the atom:title element

setTitleElement

public Entry setTitleElement(Text title)

Description copied from interface: Entry

RFC4287: The "atom:title" element is a Text construct that conveys a human-readable title for an entry or feed.

Specified by:

setTitleElement in interface Entry

Parameters:

title - the atom:title element

setTitle

public Text setTitle(String value)

Description copied from interface: Entry

Sets the value of the title as @type="text"

Specified by:

setTitle in interface Entry

Parameters:

value - The title value

Returns:

The newly created atom:title element

setTitleAsHtml

public Text setTitleAsHtml(String value)

Description copied from interface: Entry

Sets the value of the title as @type="html"

Specified by:

setTitleAsHtml in interface Entry

Parameters:

value - The title value

Returns:

The newly created atom:title element

setTitleAsXhtml

public Text setTitleAsXhtml(String value)

Description copied from interface: Entry

Sets the value of the title as @type="xhtml"

Specified by:

setTitleAsXhtml in interface Entry

Parameters:

value - The title value

Returns:

The newly created atom:title element

setTitle

public Text setTitle(String value,
                     Text.Type type)

Description copied from interface: Entry

Sets the value of the title

Specified by:

setTitle in interface Entry

Parameters:

value - The title value

type - The Text.Type of the title

Returns:

the newly created atom:title element

setTitle

public Text setTitle(Div value)

Description copied from interface: Entry

Sets the value of the title as @type="xhtml"

Specified by:

setTitle in interface Entry

Parameters:

value - The XHTML div

Returns:

the newly created atom:title element

getTitle

public String getTitle()

Description copied from interface: Entry

Returns the text string value of the title element

Specified by:

getTitle in interface Entry

Returns:

text value of the atom:title

getUpdatedElement

public DateTime getUpdatedElement()

Description copied from interface: Entry

RFC4287: The "atom:updated" element is a Date construct indicating the most recent instant in time when an entry or feed was modified in a way the publisher considers significant. Therefore, not all modifications necessarily result in a changed atom:updated value.

Specified by:

getUpdatedElement in interface Entry

Returns:

the atom:updated element

setUpdatedElement

public Entry setUpdatedElement(DateTime updated)

Description copied from interface: Entry

RFC4287: The "atom:updated" element is a Date construct indicating the most recent instant in time when an entry or feed was modified in a way the publisher considers significant. Therefore, not all modifications necessarily result in a changed atom:updated value.

Specified by:

setUpdatedElement in interface Entry

Parameters:

updated - the atom:updated element.

getUpdated

public Date getUpdated()

Description copied from interface: Entry

Return atom:updated

Specified by:

getUpdated in interface Entry

Returns:

A java.util.Date value

setUpdated

public DateTime setUpdated(Date value)

Description copied from interface: Entry

Set the atom:updated value

Specified by:

setUpdated in interface Entry

Parameters:

value - The new value

Returns:

The newly created atom:updated element

setUpdated

public DateTime setUpdated(String value)

Description copied from interface: Entry

Set the atom:updated value

Specified by:

setUpdated in interface Entry

Parameters:

value - The new value

Returns:

The newly created atom:updated element

getEditedElement

public DateTime getEditedElement()

Description copied from interface: Entry

APP Introduces a new app:edited element whose value changes every time the entry is updated

Specified by:

getEditedElement in interface Entry

Returns:

the app:edited element

setEditedElement

public void setEditedElement(DateTime updated)

Description copied from interface: Entry

Set the app:edited element

Specified by:

setEditedElement in interface Entry

Parameters:

updated - The app:edited element

getEdited

public Date getEdited()

Description copied from interface: Entry

Return the value of app:edited

Specified by:

getEdited in interface Entry

Returns:

app:edited

setEdited

public DateTime setEdited(Date value)

Description copied from interface: Entry

Set the value of app:edited

Specified by:

setEdited in interface Entry

Parameters:

value - The java.util.Date value

Returns:

The newly created app:edited element

setEdited

public DateTime setEdited(String value)

Description copied from interface: Entry

Set the value of app:edited

Specified by:

setEdited in interface Entry

Parameters:

value - the serialized string value for app:edited

Returns:

The newly created app:edited element

getControl

public Control getControl(boolean create)

Description copied from interface: Entry

Returns this entries Atom Publishing Protocol control element. A new control element will be created if one currently does not exist

Specified by:

getControl in interface Entry

Returns:

The app:control element

getControl

public Control getControl()

Description copied from interface: Entry

Returns this entries Atom Publishing Protocol control element

Specified by:

getControl in interface Entry

Returns:

The app:control element

setControl

public Entry setControl(Control control)

Description copied from interface: Entry

Sets this entries Atom Publishing Protocol control element

Specified by:

setControl in interface Entry

Parameters:

control - The app:contorl element

getLink

public Link getLink(String rel)

Description copied from interface: Entry

Returns the first link with the specified rel attribute value

Specified by:

getLink in interface Entry

Parameters:

rel - The link rel

Returns:

a Link with the specified rel attribute

getAlternateLink

public Link getAlternateLink()

Description copied from interface: Entry

Returns this entries first alternate link

Specified by:

getAlternateLink in interface Entry

Returns:

the Alternate link

getEnclosureLink

public Link getEnclosureLink()

Description copied from interface: Entry

Returns this entries first enclosure link

Specified by:

getEnclosureLink in interface Entry

Returns:

the Enclosure link

getEditLink

public Link getEditLink()

Description copied from interface: Entry

Returns this entries first edit link

Specified by:

getEditLink in interface Entry

Returns:

the Edit Link

getSelfLink

public Link getSelfLink()

Description copied from interface: Entry

Returns this entries first self link

Specified by:

getSelfLink in interface Entry

Returns:

the Self Link

getEditMediaLink

public Link getEditMediaLink()

Description copied from interface: Entry

Returns this entries first edit-media link (if any)

Specified by:

getEditMediaLink in interface Entry

Returns:

the Edit Media Link

getLinkResolvedHref

public IRI getLinkResolvedHref(String rel)

Description copied from interface: Entry

Return a link href resolved against the in-scope Base URI

Specified by:

getLinkResolvedHref in interface Entry

Parameters:

rel - The rel attribute value

Returns:

The resolved IRI

getAlternateLinkResolvedHref

public IRI getAlternateLinkResolvedHref()

Description copied from interface: Entry

Return a link href resolved against the in-scope Base URI

Specified by:

getAlternateLinkResolvedHref in interface Entry

Returns:

The resolved IRI

getEnclosureLinkResolvedHref

public IRI getEnclosureLinkResolvedHref()

Description copied from interface: Entry

Return a link href resolved against the in-scope Base URI

Specified by:

getEnclosureLinkResolvedHref in interface Entry

Returns:

The resolved IRI

getEditLinkResolvedHref

public IRI getEditLinkResolvedHref()

Description copied from interface: Entry

Return a link href resolved against the in-scope Base URI

Specified by:

getEditLinkResolvedHref in interface Entry

Returns:

The resolved IRI

getEditMediaLinkResolvedHref

public IRI getEditMediaLinkResolvedHref()

Description copied from interface: Entry

Return a link href resolved against the in-scope Base URI

Specified by:

getEditMediaLinkResolvedHref in interface Entry

Returns:

The resolved IRI

getSelfLinkResolvedHref

public IRI getSelfLinkResolvedHref()

Description copied from interface: Entry

Return a link href resolved against the in-scope Base URI

Specified by:

getSelfLinkResolvedHref in interface Entry

Returns:

The resolved IRI

getContent

public String getContent()

Description copied from interface: Entry

Returns the text of the content element

Specified by:

getContent in interface Entry

Returns:

text content

getContentStream

public InputStream getContentStream()
                             throws IOException

Description copied from interface: Entry

Returns an input stream from the content element value. This is particularly useful when dealing with Base64 binary content.

Specified by:

getContentStream in interface Entry

Throws:

IOException

getContentSrc

public IRI getContentSrc()

Description copied from interface: Entry

Returns the content/@src attribute, if any

Specified by:

getContentSrc in interface Entry

Returns:

The src IRI

getContentType

public Content.Type getContentType()

Description copied from interface: Entry

Returns the content type

Specified by:

getContentType in interface Entry

Returns:

The content type

getRightsType

public Text.Type getRightsType()

Description copied from interface: Entry

Return the @type of the atom:rights element

Specified by:

getRightsType in interface Entry

Returns:

The Text.Type of the atom:rights element

getSummaryType

public Text.Type getSummaryType()

Description copied from interface: Entry

Returns the summary type

Specified by:

getSummaryType in interface Entry

Returns:

the Text.Type of the atom:summary

getTitleType

public Text.Type getTitleType()

Description copied from interface: Entry

Returns the @type of this entries title

Specified by:

getTitleType in interface Entry

Returns:

the Text.Type of the atom:title

getContentMimeType

public javax.activation.MimeType getContentMimeType()

Description copied from interface: Entry

Returns the media type of the content type or null if type equals 'text', 'html' or 'xhtml'

Specified by:

getContentMimeType in interface Entry

Returns:

The content media type

getAlternateLink

public Link getAlternateLink(String type,
                             String hreflang)

Description copied from interface: Entry

Returns the first alternate link matching the specified type and hreflang

Specified by:

getAlternateLink in interface Entry

Parameters:

type - The link media type

hreflang - The link target language

Returns:

The matching atom:link

getAlternateLinkResolvedHref

public IRI getAlternateLinkResolvedHref(String type,
                                        String hreflang)

Description copied from interface: Entry

Return a link href resolved against the in-scope Base URI

Specified by:

getAlternateLinkResolvedHref in interface Entry

Parameters:

type - A target type

hreflang - A target language

Returns:

The resolved IRI

getEditMediaLink

public Link getEditMediaLink(String type,
                             String hreflang)

Description copied from interface: Entry

Returns the first edit-media link matching the specified type and hreflang

Specified by:

getEditMediaLink in interface Entry

Parameters:

type - a media type

hreflang - a target language

Returns:

A matching atom:link element

getEditMediaLinkResolvedHref

public IRI getEditMediaLinkResolvedHref(String type,
                                        String hreflang)

Description copied from interface: Entry

Return a link href resolved against the in-scope Base URI

Specified by:

getEditMediaLinkResolvedHref in interface Entry

Parameters:

type - A target type

hreflang - A target language

Returns:

The resolved IRI

setDraft

public Entry setDraft(boolean draft)

Description copied from interface: Entry

Sets whether or not this entry is a draft

Specified by:

setDraft in interface Entry

Parameters:

draft - true if this entry should be marked as a draft

isDraft

public boolean isDraft()

Returns true if this entry is a draft

Specified by:

isDraft in interface Entry

Returns:

True if this entry is a date

addControl

public Control addControl()

Specified by:

addControl in interface Entry