Package org.apache.abdera.model

Interface Generator

All Superinterfaces:

Base, java.lang.Cloneable, Element, java.lang.Iterable<Element>

public interface Generator
extends Element

Identifies the software implementation that produced the Atom feed.

Per RFC4287:

 The "atom:generator" element's content identifies the agent used to
  generate a feed, for debugging and other purposes.
  The content of this element, when present, MUST be a string that is a
  human-readable name for the generating agent.  Entities such as
  "&" and "<" represent their corresponding characters 
  ("&" and "<" respectively), not markup.

  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.

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

Method Summary

Modifier and Type	Method	Description
IRI	getResolvedUri()	Returns the fully qualified form of the generator element's uri attribute (resolved against the in-scope Base URI)
IRI	getUri()	The atom:generator element MAY have a "uri" attribute whose value MUST be an IRI reference [RFC3987].
java.lang.String	getVersion()	The atom:generator element MAY have a "version" attribute that indicates the version of the generating agent.
Generator	setUri(java.lang.String uri)	The atom:generator element MAY have a "uri" attribute whose value MUST be an IRI reference [RFC3987].
Generator	setVersion(java.lang.String version)	The atom:generator element MAY have a "version" attribute that indicates the version of the generating agent.

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 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 java.lang.Iterable

forEach, iterator, spliterator

Method Detail

getUri

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

Throws:

IRISyntaxException - if the uri is malformed

getResolvedUri

IRI getResolvedUri()

Returns the fully qualified form of the generator element's uri attribute (resolved against the in-scope Base URI)

Returns:

the resolved uri value

Throws:

IRISyntaxException - if the uri is malformed

setUri

Generator setUri(java.lang.String uri)

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.

Parameters:

uri - The URI attribute value

Throws:

IRISyntaxException - if the uri is malformed

getVersion

java.lang.String getVersion()

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

Returns:

The version attribute value

setVersion

Generator setVersion(java.lang.String version)

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

Parameters:

version - The version attribute