Overview
Feed element is top level element of an Atom Feed Document as defined in the Atom Syndication Format
Profile: common
Variable Summary
access | name | type | Can Read | Can Init | Can Write | Default Value | description |
---|---|---|---|---|---|---|---|
public | authors | Person[] |
Sequence of Person containing the authors of this feed. |
||||
public | categories | Category[] |
Sequences of Category containing the categories of this feed. |
||||
public | contributors | Person[] |
Sequence of Person containing the contributors of this feed. |
||||
public | generator | Generator |
The software agent used to generate this feed. |
||||
public | icon | Id |
An image that provides a iconic visual identification for this feed. |
||||
public | id | Id |
A universally unique and a permanent identifier for this entry or feed. |
||||
public | links | Link[] |
Sequence of Link describing a reference from this entry or feed to a Web resource. |
||||
public | logo | Id |
An image that provides visual identification for this feed. |
||||
public | rights | Content |
Information about rights held in and over this entry or feed. |
||||
public | subtitle | Content |
The subtitle for this feed. |
||||
public | title | Content |
The title for this entry or feed. |
||||
public | updated | Date |
A Date indicating the most recent instant in time when this entry or feed was modified |
Inherited Variables
javafx.data.feed.atom.Atom
access | name | type | Can Read | Can Init | Can Write | Default Value | description |
---|---|---|---|---|---|---|---|
public | base | String |
Base URI for the Atom feed. |
||||
protected | factory | Factory | subclass | subclass | subclass |
The factory for creating new Atom elements. |
|
public | lang | String |
The language for the Atom feed. |
||||
protected | task | FeedTask | subclass | subclass | subclass |
The Task that is currently parsing the feed. |
javafx.data.feed.Base
access | name | type | Can Read | Can Init | Can Write | Default Value | description |
---|---|---|---|---|---|---|---|
public | namespaces | Pair[] |
The namespace definitions in effect for this element. The namespace definitions in effect for this element. The |
||||
public | parent | Base |
Points to the parent, or enclosing element. Points to the parent, or enclosing element. Will be |
Inherited Functions
javafx.data.feed.atom.Atom
- protected toXML() : java.lang.String
- protected tryParseDate(text: java.lang.String) : DateTime
javafx.data.feed.Base
- protected dispatchForeignElement(parser: PullParser, task: FeedTask, refNamespace: java.lang.String) : Void
- protected escape(s: java.lang.String) : java.lang.String
-
Substitute escape sequences for markup delimiter characters in the provided string as per http://www.w3.org/TR/xml/#syntax.
Substitute escape sequences for markup delimiter characters in the provided string as per http://www.w3.org/TR/xml/#syntax. The provided string is expected to be used for character data in an XML document. The returned string will be the same string provided if no markup delimiters are found. A null string provided will result in a zero-length string returned.
-
Parameters
- s
-
Returns
- String
- protected abstract fromXML(parser: PullParser) : Void
- protected map(qname: QName) : java.lang.String
-
Map the specified QName according to namespace definitions currently in effect.
Map the specified QName according to namespace definitions currently in effect.
Returns a representation of the specified QName taking current namespace definitions into account, using the currently-mapped prefix, if one is currently mapped to the QName's namespace uri. Also recursively traverse up the hierarchy to find a match.-
Parameters
- qname
-
Returns
- String
- a String representation of the qname with its prefix adjusted to match the namespace definitions currently in effect.
- protected parseNamespaces(parser: PullParser) : Void
- protected stripCDATA(s: java.lang.String) : java.lang.String
- protected toXML() : java.lang.String
-
Generate an XML representation of the element.
Generate an XML representation of the element. The
Base
class generates an XML representation of the namespaces in effect. Overriding classes are expected to override this function and add their own representation by callingsuper.toXML()
.-
Returns
- String
- an XML representation of the element
- protected tryFromXML(parser: PullParser, task: FeedTask) : Void
-
Try to parse the element from its XML representation, reporting exceptions, if any, to the
onException
callback.Try to parse the element from its XML representation, reporting exceptions, if any, to the
onException
callback. The use of this function helps the parser recover from parse errors.-
Parameters
- parser
- task