Extended maintenance of Ruby versions 1.8.7 and 1.9.2 will end on July 31, 2014. Read more

In Files

  • rexml/attlistdecl.rb

Parent

Included Modules

REXML::AttlistDecl

This class needs:

  • Documentation

  • Work! Not all types of attlists are intelligently parsed, so we just

spew back out what we get in. This works, but it would be better if we formatted the output ourselves.

AttlistDecls provide just enough support to allow namespace declarations. If you need some sort of generalized support, or have an interesting idea about how to map the hideous, terrible design of DTD AttlistDecls onto an intuitive Ruby interface, let me know. I’m desperate for anything to make DTDs more palateable.

Attributes

element_name[R]

What is this? Got me.

Public Class Methods

new(source) click to toggle source

Create an AttlistDecl, pulling the information from a Source. Notice that this isn’t very convenient; to create an AttlistDecl, you basically have to format it yourself, and then have the initializer parse it. Sorry, but for the forseeable future, DTD support in REXML is pretty weak on convenience. Have I mentioned how much I hate DTDs?

 
               # File rexml/attlistdecl.rb, line 28
def initialize(source)
  super()
  if (source.kind_of? Array)
    @element_name, @pairs, @contents = *source
  end
end
            

Public Instance Methods

[](key) click to toggle source

Access the attlist attribute/value pairs.

value = attlist_decl[ attribute_name ]
 
               # File rexml/attlistdecl.rb, line 37
def [](key)
  @pairs[key]
end
            
each(&block) click to toggle source

Iterate over the key/value pairs:

attlist_decl.each { |attribute_name, attribute_value| ... }
 
               # File rexml/attlistdecl.rb, line 49
def each(&block)
  @pairs.each(&block)
end
            
include?(key) click to toggle source

Whether an attlist declaration includes the given attribute definition

if attlist_decl.include? "xmlns:foobar"
 
               # File rexml/attlistdecl.rb, line 43
def include?(key)
  @pairs.keys.include? key
end
            
node_type() click to toggle source
 
               # File rexml/attlistdecl.rb, line 58
def node_type
  :attlistdecl
end
            
write(out, indent=-1) click to toggle source

Write out exactly what we got in.

 
               # File rexml/attlistdecl.rb, line 54
def write out, indent=-1
  out << @contents
end
            

Commenting is here to help enhance the documentation. For example, code samples, or clarification of the documentation.

If you have questions about Ruby or the documentation, please post to one of the Ruby mailing lists. You will get better, faster, help that way.

If you wish to post a correction of the docs, please do so, but also file bug report so that it can be corrected for the next release. Thank you.

If you want to help improve the Ruby documentation, please visit Documenting-ruby.org.

blog comments powered by Disqus