REXML::Parent

Inheritance: < REXML::Child < Object
Included Modules: Enumerable

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

Class

Visibility	Signature
public	new (parent=nil)

Instance

Visibility	Signature
public	<< ( object )
public	[] ( index )
public	[]= ( *args )
public	add ( object )
public	children ()
public	deep_clone ()
public	delete ( object )
public	delete_at ( index )
public	delete_if ( &block )
public	each (&block)
public	each_child (&block)
public	each_index ( &block )
public	index ( child )
public	insert_after ( child1, child2 )
public	insert_before ( child1, child2 )
public	length ()
public	parent? ()
public	push ( object )
public	replace_child ( to_replace, replacement )
public	size ()
public	to_a ()
public	unshift ( object )

Class Method Detail

new(parent=nil)

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

Instance Method Detail

<<( object )

Alias for push

[]( index )

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

[]=( *args )

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)

add( object )

children()

Alias for to_a

deep_clone()

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

delete( object )

delete_at( index )

delete_if( &block )

each(&block)

each_child(&block)

Alias for each

each_index( &block )

index( child )

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.

insert_after( child1, child2 )

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)

insert_before( child1, child2 )

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)

length()

Alias for size

parent?()

push( object )

Alias for add

replace_child( to_replace, replacement )

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)

size()

@return the number of children of this parent