module REXML::StreamListener - rexml: Ruby Standard Library Documentation

# module REXML::StreamListener

A template for stream parser listeners. Note that the declarations (attlistdecl, elementdecl, etc) are trivially processed; `REXML` doesn’t yet handle doctype entity declarations, so you have to parse them out yourself.

### Public Instance Methods

attlistdecl(element_name, attributes, raw_content) click to toggle source

If a doctype includes an ATTLIST declaration, it will cause this method to be called. The content is the declaration itself, unparsed. EG, <!ATTLIST el attr CDATA REQUIRED> will come to this method as “el attr CDATA REQUIRED”. This is the same for all of the .*decl methods.

    # File rexml-3.4.0/lib/rexml/streamlistener.rb, line 51
    def attlistdecl element_name, attributes, raw_content
    end

cdata(content) click to toggle source

Called when <![CDATA[ … ]]> is encountered in a document. @p content “…”

    # File rexml-3.4.0/lib/rexml/streamlistener.rb, line 83
    def cdata content
    end

comment(comment) click to toggle source

Called when a comment is encountered. @p comment The content of the comment

    # File rexml-3.4.0/lib/rexml/streamlistener.rb, line 33
    def comment comment
    end

doctype(name, pub_sys, long_name, uri) click to toggle source

Handles a doctype declaration. Any attributes of the doctype which are not supplied will be nil. # EG, <!DOCTYPE me PUBLIC “foo” “bar”> @p name the name of the doctype; EG, “me” @p pub_sys “PUBLIC”, “SYSTEM”, or nil. EG, “PUBLIC” @p long_name the supplied long name, or nil. EG, “foo” @p uri the uri of the doctype, or nil. EG, “bar”

    # File rexml-3.4.0/lib/rexml/streamlistener.rb, line 41
    def doctype name, pub_sys, long_name, uri
    end

doctype_end() click to toggle source

Called when the doctype is done

    # File rexml-3.4.0/lib/rexml/streamlistener.rb, line 44
    def doctype_end
    end

elementdecl(content) click to toggle source

<!ELEMENT …>

    # File rexml-3.4.0/lib/rexml/streamlistener.rb, line 54
    def elementdecl content
    end

entity(content) click to toggle source

Called when %foo; is encountered in a doctype declaration. @p content “foo”

    # File rexml-3.4.0/lib/rexml/streamlistener.rb, line 79
    def entity content
    end

entitydecl(content) click to toggle source

<!ENTITY …> The argument passed to this method is an array of the entity declaration. It can be in a number of formats, but in general it returns (example, result):

    <!ENTITY % YN '"Yes"'>
    ["YN", "\"Yes\"", "%"]
    <!ENTITY % YN 'Yes'>
    ["YN", "Yes", "%"]
    <!ENTITY WhatHeSaid "He said %YN;">
    ["WhatHeSaid", "He said %YN;"]
    <!ENTITY open-hatch SYSTEM "http://www.textuality.com/boilerplate/OpenHatch.xml">
    ["open-hatch", "SYSTEM", "http://www.textuality.com/boilerplate/OpenHatch.xml"]
    <!ENTITY open-hatch PUBLIC "-//Textuality//TEXT Standard open-hatch boilerplate//EN" "http://www.textuality.com/boilerplate/OpenHatch.xml">
    ["open-hatch", "PUBLIC", "-//Textuality//TEXT Standard open-hatch boilerplate//EN", "http://www.textuality.com/boilerplate/OpenHatch.xml"]
    <!ENTITY hatch-pic SYSTEM "../grafix/OpenHatch.gif" NDATA gif>
    ["hatch-pic", "SYSTEM", "../grafix/OpenHatch.gif", "gif"]

    # File rexml-3.4.0/lib/rexml/streamlistener.rb, line 72
    def entitydecl content
    end

instruction(name, instruction) click to toggle source

Called when an instruction is encountered. EG: <?xsl sheet=‘foo’?> @p name the instruction name; in the example, “xsl” @p instruction the rest of the instruction. In the example, “sheet=‘foo’”

    # File rexml-3.4.0/lib/rexml/streamlistener.rb, line 29
    def instruction name, instruction
    end

notationdecl(content) click to toggle source

<!NOTATION …>

    # File rexml-3.4.0/lib/rexml/streamlistener.rb, line 75
    def notationdecl content
    end

tag_end(name) click to toggle source

Called when the end tag is reached. In the case of <tag/>, `tag_end` will be called immediately after `tag_start` @p the name of the tag

    # File rexml-3.4.0/lib/rexml/streamlistener.rb, line 19
    def tag_end name
    end

tag_start(name, attrs) click to toggle source

Called when a tag is encountered. @p name the tag name @p attrs an array of arrays of attribute/value pairs, suitable for use with assoc or rassoc. IE, <tag attr1=“value1” attr2=“value2”> will result in `tag_start`( “tag”, # [[“attr1”,“value1”],])

    # File rexml-3.4.0/lib/rexml/streamlistener.rb, line 14
    def tag_start name, attrs
    end

text(text) click to toggle source

Called when text is encountered in the document @p text the text content.

    # File rexml-3.4.0/lib/rexml/streamlistener.rb, line 23
    def text text
    end

xmldecl(version, encoding, standalone) click to toggle source

Called when an XML PI is encountered in the document. EG: <?xml version=“1.0” encoding=“utf”?> @p version the version attribute value. EG, “1.0” @p encoding the encoding attribute value, or nil. EG, “utf” @p standalone the standalone attribute value, or nil. EG, nil

    # File rexml-3.4.0/lib/rexml/streamlistener.rb, line 90
    def xmldecl version, encoding, standalone
    end