Class REXML::Comment
In: rexml/comment.rb
Parent: Child

Represents an XML comment; that is, text between <!— … —>

Methods

<=>   ==   clone   new   node_type   write  

Included Modules

Comparable

Constants

START = "<!--"
STOP = "-->"

External Aliases

string -> to_s

Attributes

string  [RW]  The content text

Public Class methods

new( first, second = nil )

Constructor. The first argument can be one of three types: @param first If String, the contents of this comment are set to the argument. If Comment, the argument is duplicated. If Source, the argument is scanned for a comment. @param second If the first argument is a Source, this argument should be nil, not supplied, or a Parent to be set as the parent of this object

[Source]

# File rexml/comment.rb, line 23
                def initialize( first, second = nil )
                        #puts "IN COMMENT CONSTRUCTOR; SECOND IS #{second.type}"
                        super(second)
                        if first.kind_of? String
                                @string = first
                        elsif first.kind_of? Comment
                                @string = first.string
                        end
                end

Public Instance methods

<=>(other)

Compares this Comment to another; the contents of the comment are used in the comparison.

[Source]

# File rexml/comment.rb, line 63
                def <=>(other)
                        other.to_s <=> @string
                end
==( other )

Compares this Comment to another; the contents of the comment are used in the comparison.

[Source]

# File rexml/comment.rb, line 70
                def ==( other )
                        other.kind_of? Comment and
                        (other <=> self) == 0
                end
clone()

[Source]

# File rexml/comment.rb, line 33
                def clone
                        Comment.new self
                end
node_type()

[Source]

# File rexml/comment.rb, line 75
    def node_type
      :comment
    end
write( output, indent=-1, transitive=false, ie_hack=false )

DEPRECATED

See REXML::Formatters

output:Where to write the string
indent:An integer. If -1, no indenting will be used; otherwise, the indentation will be this number of spaces, and children will be indented an additional amount.
transitive:Ignored by this class. The contents of comments are never modified.
ie_hack:Needed for conformity to the child API, but not used by this class.

[Source]

# File rexml/comment.rb, line 50
                def write( output, indent=-1, transitive=false, ie_hack=false )
      Kernel.warn("Comment.write is deprecated.  See REXML::Formatters")
                        indent( output, indent )
                        output << START
                        output << @string
                        output << STOP
                end

[Validate]

ruby-doc.org is hosted and maintained by James Britt and Happy Camper Studios, a Ruby application development company in Phoenix, Arizona. The site was created in 2002 as part of the Ruby Documentation Project to promote the Ruby language and to help other Ruby hackers.

Documentation content on ruby-doc.org is provided by remarkable members of the Ruby community.

For more information on the Ruby programming language, visit ruby-lang.org.

Want to help improve Ruby's API docs? See Ruby Documentation Guidelines.