JavaFX: Bringing Rich Experiences To All the Screens Of Your Life

expand all

Profile: desktop, common

Overview

Base class for the elements of an Atom feed.

Profile: common

Script Variable Summary

accessnametypeCan ReadCan InitCan WriteDefault Valuedescription
publicAUTHORQName

The qualified name of a Author element in the default Atom namespace

publicCATEGORYQName

The qualified name of a Category element in the default Atom namespace

publicCONTENTQName

The qualified name of a Content element in the default Atom namespace

publicCONTRIBUTORQName

The qualified name of a Contributor element in the default Atom namespace

publicEMAILQName

The qualified name of a Email element in the default Atom namespace

publicENTRYQName

The qualified name of a Entry element in the default Atom namespace

publicENTRY_MIMETYPEString

MIME media type of an Atom Entry Document when serialized as XML

publicFEEDQName

The qualified name of a Feed element in the default Atom namespace

publicFEED_MIMETYPEString

MIME media type of an Atom Feed Document when serialized as XML

publicFIXEDQName

The qualified name of a fixed attribute

publicGENERATORQName

The qualified name of a Generator element in the default Atom namespace

publicICONQName

The qualified name of a Icon element in the default Atom namespace

publicIDQName

The qualified name of a Id element in the default Atom namespace

publicLABELQName

The qualified name of a label attribute

publicLINKQName

The qualified name of a Link element in the default Atom namespace

publicLINK_HREFQName

The qualified name of a href attribute

publicLINK_HREFLANGQName

The qualified name of a hreflang attribute

publicLINK_LENGTHQName

The qualified name of a length attribute

publicLINK_RELQName

The qualified name of a rel attribute

publicLINK_TITLEQName

The qualified name of a title attribute

publicLINK_TYPEQName

The qualified name of a type attribute

publicLOGOQName

The qualified name of a Logo element in the default Atom namespace

publicNAMEQName

The qualified name of a Name element in the default Atom namespace

publicNAMESPACEString

The default Atom namespace

publicNOQName

The qualified name of a no attribute

publicPUBLISHEDQName

The qualified name of a Published element in the default Atom namespace

publicRIGHTSQName

The qualified name of a Rights element in the default Atom namespace

publicSCHEMEQName

The qualified name of a scheme attribute

publicSOURCEQName

The qualified name of a Source element in the default Atom namespace

publicSRCQName

The qualified name of a src attribute

publicSUBTITLEQName

The qualified name of a Subtitle element in the default Atom namespace

publicSUMMARYQName

The qualified name of a Summary element in the default Atom namespace

publicTERMQName

The qualified name of a term attribute

publicTITLEQName

The qualified name of a Title element in the default Atom namespace

publicUNQUALIFIED_URIQName

The qualified name of a uri attribute

publicUPDATEDQName

The qualified name of a Updated element in the default Atom namespace

publicURIQName

The qualified name of a URI element in the default Atom namespace

publicVERSIONQName

The qualified name of a version attribute

publicXML_BASEQName

Value of a QName to identify base URI in the default XML namespace

publicXML_LANGQName

Value of a QName to identify the language in the default XML namespace

publicYESQName

The qualified name of a yes attribute

Variable Summary

accessnametypeCan ReadCan InitCan WriteDefault Valuedescription
publicbaseString

Base URI for the Atom feed.

protectedfactoryFactorysubclasssubclasssubclass

The factory for creating new Atom elements.

publiclangString

The language for the Atom feed.

protectedtaskFeedTasksubclasssubclasssubclass

The Task that is currently parsing the feed.

Inherited Variables

javafx.data.feed.Base

accessnametypeCan ReadCan InitCan WriteDefault Valuedescription
publicnamespacesPair[]

The namespace definitions in effect for this element.

The namespace definitions in effect for this element. The name attribute of the Pair contains the namespace prefix and the value attribute contains the namespace URI.

 
publicparentBase

Points to the parent, or enclosing element.

Points to the parent, or enclosing element. Will be null if there is no parent.

 

Function Summary

protected toXML() : java.lang.String
Returns
String
 
protected tryParseDate(text: java.lang.String) : DateTime
Parameters
text
Returns
DateTime
 

Inherited Functions

javafx.data.feed.Base

protected dispatchForeignElement(parser: PullParser, task: FeedTask, refNamespace: java.lang.String) : Void

Determine if the current event is a foreign event and report it to the registered callback, if any.

Determine if the current event is a foreign event and report it to the registered callback, if any.

Parameters
parser
task
refNamespace
 
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

Subclasses override this function to parse themselves from the XML stream events generated by the parser.

Subclasses override this function to parse themselves from the XML stream events generated by the parser.

Parameters
parser
 
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

Parse namespace definitions for this element, if any.

Parse namespace definitions for this element, if any.

Parameters
parser
 
protected stripCDATA(s: java.lang.String) : java.lang.String

Remove CDATA start and end markers from content.

Remove CDATA start and end markers from content.

Parameters
s
Returns
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 calling super.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