Class REXML::Parent
In: rexml/parent.rb
Parent: Child

A parent has children, and has methods for accessing them. The Parent class is never encountered except as the superclass for some other object.

Methods

<<   []   []=   add   children   deep_clone   delete   delete_at   delete_if   each   each_child   each_index   index   insert_after   insert_before   length   new   parent?   push   replace_child   size   to_a   unshift  

Included Modules

Enumerable

Public Class methods

Constructor @param parent if supplied, will be set as the parent of this object

[Source]

# File rexml/parent.rb, line 12
    def initialize parent=nil
      super(parent)
      @children = []
    end

Public Instance methods

<<( object )

Alias for push

Fetches a child at a given index @param index the Integer index of the child to fetch

[Source]

# File rexml/parent.rb, line 57
    def []( index )
      @children[index]
    end

Set an index entry. See Array.[]= @param index the index of the element to set @param opt either the object to set, or an Integer length @param child if opt is an Integer, this is the child to set @return the parent (self)

[Source]

# File rexml/parent.rb, line 70
    def []=( *args )
      args[-1].parent = self
      @children[*args[0..-2]] = args[-1]
    end

[Source]

# File rexml/parent.rb, line 17
    def add( object )
      #puts "PARENT GOTS #{size} CHILDREN"
      object.parent = self
      @children << object
      #puts "PARENT NOW GOTS #{size} CHILDREN"
      object
    end
children()

Alias for to_a

Deeply clones this object. This creates a complete duplicate of this Parent, including all descendants.

[Source]

# File rexml/parent.rb, line 148
    def deep_clone
      cl = clone()
      each do |child|
        if child.kind_of? Parent
          cl << child.deep_clone
        else
          cl << child.clone
        end
      end
      cl
    end

[Source]

# File rexml/parent.rb, line 33
    def delete( object )
      found = false
      @children.delete_if {|c| c.equal?(object) and found = true }
      object.parent = nil if found
    end

[Source]

# File rexml/parent.rb, line 47
    def delete_at( index )
      @children.delete_at index
    end

[Source]

# File rexml/parent.rb, line 43
    def delete_if( &block )
      @children.delete_if(&block)
    end

[Source]

# File rexml/parent.rb, line 39
    def each(&block)
      @children.each(&block)
    end
each_child(&block)

Alias for each

[Source]

# File rexml/parent.rb, line 51
    def each_index( &block )
      @children.each_index(&block)
    end

Fetches the index of a given child @param child the child to get the index of @return the index of the child, or nil if the object is not a child of this parent.

[Source]

# File rexml/parent.rb, line 123
    def index( child )
      count = -1
      @children.find { |i| count += 1 ; i.hash == child.hash }
      count
    end

Inserts an child after another child @param child1 this is either an xpath or an Element. If an Element, child2 will be inserted after child1 in the child list of the parent. If an xpath, child2 will be inserted after the first child to match the xpath. @param child2 the child to insert @return the parent (self)

[Source]

# File rexml/parent.rb, line 102
    def insert_after( child1, child2 )
      if child1.kind_of? String
        child1 = XPath.first( self, child1 )
        child1.parent.insert_after child1, child2
      else
        ind = index(child1)+1
        child2.parent.delete(child2) if child2.parent
        @children[ind,0] = child2
        child2.parent = self
      end
      self
    end

Inserts an child before another child @param child1 this is either an xpath or an Element. If an Element, child2 will be inserted before child1 in the child list of the parent. If an xpath, child2 will be inserted before the first child to match the xpath. @param child2 the child to insert @return the parent (self)

[Source]

# File rexml/parent.rb, line 82
    def insert_before( child1, child2 )
      if child1.kind_of? String
        child1 = XPath.first( self, child1 )
        child1.parent.insert_before child1, child2
      else
        ind = index(child1)
        child2.parent.delete(child2) if child2.parent
        @children[ind,0] = child2
        child2.parent = self
      end
      self
    end
length()

Alias for size

[Source]

# File rexml/parent.rb, line 162
    def parent?
      true
    end
push( object )

Alias for add

Replaces one child with another, making sure the nodelist is correct @param to_replace the child to replace (must be a Child) @param replacement the child to insert into the nodelist (must be a Child)

[Source]

# File rexml/parent.rb, line 140
    def replace_child( to_replace, replacement )
      @children.map! {|c| c.equal?( to_replace ) ? replacement : c }
      to_replace.parent = nil
      replacement.parent = self
    end

@return the number of children of this parent

[Source]

# File rexml/parent.rb, line 130
    def size
      @children.size
    end

[Source]

# File rexml/parent.rb, line 115
    def to_a
      @children.dup
    end

[Source]

# File rexml/parent.rb, line 28
    def unshift( object )
      object.parent = self
      @children.unshift object
    end

[Validate]

ruby-doc.org is a community service provided by Happy Camper Studios, a Phoenix, Arizona, Ruby application development company.

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.