Class: REXML::Instruction

Inherits:
Child show all
Defined in:
lib/rexml/instruction.rb

Overview

Represents an XML Instruction; IE, <? … ?> TODO: Add parent arg (3rd arg) to constructor

Constant Summary collapse

START = 
"<?"
STOP = 
"?>"

Instance Attribute Summary collapse

Attributes inherited from Child

#parent

Instance Method Summary collapse

Methods inherited from Child

#bytes, #document, #next_sibling=, #previous_sibling=, #remove, #replace_with

Methods included from Node

#each_recursive, #find_first_recursive, #indent, #index_in_parent, #next_sibling_node, #parent?, #previous_sibling_node, #to_s

Constructor Details

#initialize(target, content = nil) ⇒ Instruction

Constructs a new Instruction the target of this instruction is set to this. If an Instruction, then the Instruction is shallowly cloned (target and content are copied). be a Parent if the target argument is a Source. Otherwise, this String is set as the content of this instruction.

Parameters:

  • target —

    can be one of a number of things. If String, then

  • content (defaults to: nil) —

    Must be either a String, or a Parent. Can only



25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
 
# File 'lib/rexml/instruction.rb', line 25

def initialize(target, content=nil)
  case target
  when String
    super()
    @target = target
    @content = content
  when Instruction
    super(content)
    @target = target.target
    @content = target.content
  else
    message =
      "processing instruction target must be String or REXML::Instruction: "
    message << "<#{target.inspect}>"
    raise ArgumentError, message
  end
  @content.strip! if @content
end

Instance Attribute Details

#content ⇒ Object

target is the “name” of the Instruction; IE, the “tag” in <?tag …?> content is everything else.



15
16
17
 
# File 'lib/rexml/instruction.rb', line 15

def content
  @content
end

#target ⇒ Object

target is the “name” of the Instruction; IE, the “tag” in <?tag …?> content is everything else.



15
16
17
 
# File 'lib/rexml/instruction.rb', line 15

def target
  @target
end

Instance Method Details

#==(other) ⇒ Object

of the other matches the target and content of this object.

Returns:

  • true if other is an Instruction, and the content and target



65
66
67
68
69
 
# File 'lib/rexml/instruction.rb', line 65

def ==( other )
  other.kind_of? Instruction and
  other.target == @target and
  other.content == @content
end

#clone ⇒ Object 



44
45
46
 
# File 'lib/rexml/instruction.rb', line 44

def clone
  Instruction.new self
end

#inspect ⇒ Object 



75
76
77
 
# File 'lib/rexml/instruction.rb', line 75

def inspect
  "<?p-i #{target} ...?>"
end

#node_type ⇒ Object 



71
72
73
 
# File 'lib/rexml/instruction.rb', line 71

def node_type
  :processing_instruction
end

#write(writer, indent = -1,, transitive = false, ie_hack = false) ⇒ Object

DEPRECATED

See the rexml/formatters package



51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/rexml/instruction.rb', line 51

def write writer, indent=-1, transitive=false, ie_hack=false
  Kernel.warn( "#{self.class.name}.write is deprecated", uplevel: 1)
  indent(writer, indent)
  writer << START
  writer << @target
  if @content
    writer << ' '
    writer << @content
  end
  writer << STOP
end