gnu.java.beans.encoder

Class Root


public class Root
extends Object

Root provides a simple interface to a tree of objects.

Using an instance of this class a logical representation of the real object tree that is serialized can be built. When the actual data should be written as XML Root and Element class can provide context information which is used to write the best fitting XML representation.

Constructor Summary

Root()
The basic constructor.

Method Summary

void
addChild(Element elem)
Adds another child element to the tree.

The new element automatically becomes the current element.

void
close(Writer writer)
Writes the closing element and closes the Writer
void
deleteLast()
Goes back to the nearest parent element but deletes the just created child.

This is used if something went wrong while processing the child element's Expression or Statement.

void
end()
Marks that the end of the current element is reached and that no more childs are added to it.

The behavior is to return to the nearest parent element.

void
traverse(Writer writer)
Traverses the elements in the object tree and creates their XML representation in the output stream of the given Writer.

Finally the Writer is flushed.

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Root

public Root()
The basic constructor. Object is special, because it has no superclass, so there is no call to super().

Method Details

addChild

public void addChild(Element elem)
Adds another child element to the tree.

The new element automatically becomes the current element.

Parameters:
elem - The new child element.

close

public void close(Writer writer)
Writes the closing element and closes the Writer
Parameters:
writer - The Writer instance that generates the XML representation.

deleteLast

public void deleteLast()
Goes back to the nearest parent element but deletes the just created child.

This is used if something went wrong while processing the child element's Expression or Statement.


end

public void end()
Marks that the end of the current element is reached and that no more childs are added to it.

The behavior is to return to the nearest parent element.


traverse

public void traverse(Writer writer)
Traverses the elements in the object tree and creates their XML representation in the output stream of the given Writer.

Finally the Writer is flushed.

Parameters:
writer - The Writer instance that generates the XML representation.

Root.java -- The root of an object tree. Copyright (C) 2005 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.