org.apache.abdera.model
Interface Generator

All Superinterfaces:
Base, java.lang.Cloneable, Element, java.io.Serializable

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
 java.net.URI getResolvedUri()
          Returns the fully qualified form of the generator element's uri attribute (resolved against the in-scope Base URI)
 java.net.URI 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.
 void setUri(java.lang.String uri)
          The atom:generator element MAY have a "uri" attribute whose value MUST be an IRI reference [RFC3987].
 void 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.Element
discard, getAttributes, getAttributeValue, getAttributeValue, getBaseUri, getDocument, getExtensionAttributes, getFirstChild, getFirstChild, getLanguage, 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
clone, getFactory, writeTo, writeTo
 

Method Detail

getUri

java.net.URI getUri()
                    throws java.net.URISyntaxException
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:
java.net.URISyntaxException

getResolvedUri

java.net.URI getResolvedUri()
                            throws java.net.URISyntaxException
Returns the fully qualified form of the generator element's uri attribute (resolved against the in-scope Base URI)

Throws:
java.net.URISyntaxException

setUri

void setUri(java.lang.String uri)
            throws java.net.URISyntaxException
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:
java.net.URISyntaxException

getVersion

java.lang.String getVersion()
The atom:generator element MAY have a "version" attribute that indicates the version of the generating agent.


setVersion

void setVersion(java.lang.String version)
The atom:generator element MAY have a "version" attribute that indicates the version of the generating agent.