Class REXML::Comment
In: lib/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 lib/rexml/comment.rb, line 23
23:                 def initialize( first, second = nil )
24:                         #puts "IN COMMENT CONSTRUCTOR; SECOND IS #{second.type}"
25:                         super(second)
26:                         if first.kind_of? String
27:                                 @string = first
28:                         elsif first.kind_of? Comment
29:                                 @string = first.string
30:                         end
31:                 end

Public Instance methods

<=>(other)

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

[Source]

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

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

[Source]

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

[Source]

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

[Source]

    # File lib/rexml/comment.rb, line 75
75:     def node_type
76:       :comment
77:     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 lib/rexml/comment.rb, line 50
50:                 def write( output, indent=-1, transitive=false, ie_hack=false )
51:       Kernel.warn("Comment.write is deprecated.  See REXML::Formatters")
52:                         indent( output, indent )
53:                         output << START
54:                         output << @string
55:                         output << STOP
56:                 end

[Validate]