gnu.java.beans.encoder.elements

Class Element

Known Direct Subclasses:
ArrayInstantiation, Array_Get, Array_Set, ClassResolution, List_Get, List_Set, MethodInvocation, NullObject, ObjectInstantiation, ObjectReference, PrimitiveInstantiation, StaticFieldAccess, StaticMethodInvocation, StringReference

public abstract class Element
extends Object

Element is the base class for the object tree elements.

It provides the neccessary infrastructure every element subclass needs in order to interact with the Root class.

Method Summary

void
addChild(Element elem)
Adds a child element to this Element.
void
clear()
Clears all the stored child elements.
ObjectId
getId()
Retrieves the element's ObjectId instance if it has one.
void
initId(ObjectId objectId)
Sets an ObjectId instance in this Element.
boolean
isEmpty()
Returns whether this element contains child elements.
Iterator<E>
iterator()
Provides access to the child elements via an iterator.
void
removeLast()
Removes the child element added last.
void
writeEnd(Writer writer)
Writes the closing XML tag.
abstract void
writeStart(Writer writer)
Writes the opening XML tag.

Methods inherited from class java.lang.Object

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

Method Details

addChild

public final void addChild(Element elem)
Adds a child element to this Element.
Parameters:
elem - The new child.

clear

public final void clear()
Clears all the stored child elements.

getId

public final ObjectId getId()
Retrieves the element's ObjectId instance if it has one.
Returns:
The ObjectId instance or null.

initId

public final void initId(ObjectId objectId)
Sets an ObjectId instance in this Element.

This can only be done once.

Parameters:
objectId - An ObjectId instance.

isEmpty

public final boolean isEmpty()
Returns whether this element contains child elements.

This method is useful to decide which formatting variant for the XML element can be chosen.

Returns:
Whether the element has child elements.

iterator

public final Iterator<E> iterator()
Provides access to the child elements via an iterator.
Returns:
An iterator for the child elements.

removeLast

public final void removeLast()
Removes the child element added last.

writeEnd

public void writeEnd(Writer writer)
Writes the closing XML tag.

By default this does writer.writeEnd(children.isEmpty()). Override if neccessary, for example when using the Writer.writeNoChildren(String,String) method variants.

Parameters:
writer - The writer to be used for XML writing.

writeStart

public abstract void writeStart(Writer writer)
Writes the opening XML tag.
Parameters:
writer - The writer to be used for XML writing.

Element.java -- Base class for object tree elements. 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.