Class: REXML::Comment (Ruby 2.7.5)
Description: Class : REXML::Comment - Ruby 2.7.5

### Home Classes Methods

### In Files

- rexml/comment.rb
- rexml/formatters/default.rb

### Parent

REXML::Child

### Methods

- ::new
- #<=>
- #==
- #clone
- #node_type
- #write

### Included Modules

- Comparable

### Class/Module Index

Quicksearch

- Array
- Float
- Integer
- Object
- REXML
- REXML::AttlistDecl
- REXML::Attribute
- REXML::Attributes
- REXML::CData
- REXML::Child
- REXML::Comment
- REXML::DTD
- REXML::DTD::AttlistDecl
- REXML::DTD::ElementDecl
- REXML::DTD::EntityDecl
- REXML::DTD::NotationDecl
- REXML::DTD::Parser
- REXML::Declaration
- REXML::DocType
- REXML::Document
- REXML::Element
- REXML::ElementDecl
- REXML::Elements
- REXML::Encoding
- REXML::Entity
- REXML::EntityConst
- REXML::ExternalEntity
- REXML::Formatters
- REXML::Formatters::Default
- REXML::Formatters::Pretty
- REXML::Formatters::Transitive
- REXML::Functions
- REXML::IOSource
- REXML::Instruction
- REXML::Light
- REXML::Light::Node
- REXML::Namespace
- REXML::Node
- REXML::NotationDecl
- REXML::Output
- REXML::Parent
- REXML::ParseException
- REXML::Parsers
- REXML::Parsers::BaseParser
- REXML::Parsers::LightParser
- REXML::Parsers::PullEvent
- REXML::Parsers::PullParser
- REXML::Parsers::SAX2Parser
- REXML::Parsers::StreamParser
- REXML::Parsers::TreeParser
- REXML::Parsers::UltraLightParser
- REXML::Parsers::XPathParser
- REXML::QuickPath
- REXML::ReferenceWriter
- REXML::SAX2Listener
- REXML::Security
- REXML::Source
- REXML::SourceFactory
- REXML::StreamListener
- REXML::Text
- REXML::UndefinedNamespaceException
- REXML::Validation
- REXML::Validation::Choice
- REXML::Validation::Event
- REXML::Validation::Interleave
- REXML::Validation::OneOrMore
- REXML::Validation::Optional
- REXML::Validation::Ref
- REXML::Validation::RelaxNG
- REXML::Validation::Sequence
- REXML::Validation::State
- REXML::Validation::ValidationException
- REXML::Validation::Validator
- REXML::Validation::ZeroOrMore
- REXML::XMLDecl
- REXML::XMLTokens
- REXML::XPath
- REXML::XPathNode
- REXML::XPathParser
- Symbol

No matching classes.

# REXML::Comment

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

### Constants

START
STOP

### Attributes

string[RW]

The content text

to_s[RW]

The content text

### Public Class Methods

new( first, second = nil ) click to toggle source

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

                   # File rexml/comment.rb, line 24
    def initialize( first, second = nil )
      super(second)
      if first.kind_of? String
        @string = first
      elsif first.kind_of? Comment
        @string = first.string
      end
    end

### Public Instance Methods

<=>(other) click to toggle source

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

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

==( other ) click to toggle source

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

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

clone() click to toggle source

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

node_type() click to toggle source

                   # File rexml/comment.rb, line 75
    def node_type
      :comment
    end

write( output, indent=-1, transitive=false, ie_hack=false ) click to toggle source

## 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.

                   # 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", uplevel: 1)
      indent( output, indent )
      output << START
      output << @string
      output << STOP
    end