gnu.java.beans.encoder

Class StAXWriter

Implemented Interfaces:
Writer

public class StAXWriter
extends Object
implements Writer

A Writer implementation based on the StAX API.

Constructor Summary

StAXWriter(OutputStream os)

Method Summary

void
close()
Closes the writer.
void
flush()
Forces the implementation to write some data.
void
write(String tagName, boolean empty)
Writes an XML tag without any attributes.
void
write(String tagName, String value)
Writes an XML tag with no attributes but with a body text that may have child elements.
void
write(String tagName, String attributeName, String attributeValue, boolean empty)
Writes an XML tag with one attribute name and value.
void
write(String tagName, String value, String[] attributeNames, String[] attributeValues, boolean empty)
Writes an XML tag with multiple attributes and a body text.
void
write(String tagName, String[] attributeNames, String[] attributeValues, boolean empty)
Writes an XML tag with multiple attributes without a body text.
void
writeEnd(boolean wasEmpty)
Writes the end of an XML tag.
void
writeEndNoChildren()
Writes the end of an XML tag that has no child elements.
void
writeNoChildren(String tagName, String value)
Writes an XML tag with no attributes but with a body text that does not have child elements.
void
writePreamble()
Writes the XML preamble.

Methods inherited from class java.lang.Object

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

Constructor Details

StAXWriter

public StAXWriter(OutputStream os)

Method Details

close

public void close()
Closes the writer.
Specified by:
close in interface Writer

flush

public void flush()
Forces the implementation to write some data.
Specified by:
flush in interface Writer

write

public void write(String tagName,
                  boolean empty)
Writes an XML tag without any attributes.
Specified by:
write in interface Writer
Parameters:
tagName - The name of the tag to write.
empty - Whether the element has child elements.

write

public void write(String tagName,
                  String value)
Writes an XML tag with no attributes but with a body text that may have child elements.
Specified by:
write in interface Writer
Parameters:
tagName - The name of the tag to write.
value - The element's body content.

write

public void write(String tagName,
                  String attributeName,
                  String attributeValue,
                  boolean empty)
Writes an XML tag with one attribute name and value.
Specified by:
write in interface Writer
Parameters:
tagName - The name of the tag to write.
attributeName - The name of attribute.
attributeValue - The attribute's value.
empty - Whether the element has child elements.

write

public void write(String tagName,
                  String value,
                  String[] attributeNames,
                  String[] attributeValues,
                  boolean empty)
Writes an XML tag with multiple attributes and a body text.
Specified by:
write in interface Writer
Parameters:
tagName - The name of the tag to write.
value - The element's body content.
attributeNames - A set of attribute names.
attributeValues - A set of attribute values.
empty - Whether the element has child elements.

write

public void write(String tagName,
                  String[] attributeNames,
                  String[] attributeValues,
                  boolean empty)
Writes an XML tag with multiple attributes without a body text.
Specified by:
write in interface Writer
Parameters:
tagName - The name of the tag to write.
attributeNames - A set of attribute names.
attributeValues - A set of attribute values.
empty - Whether the element has child elements.

writeEnd

public void writeEnd(boolean wasEmpty)
Writes the end of an XML tag.

If your tag has not generated any body text or child elements provide true as the argument to generate more space efficient variant of the tag.>/p>

Specified by:
writeEnd in interface Writer
Parameters:
wasEmpty - Whether the tag was empty or not.

writeEndNoChildren

public void writeEndNoChildren()
Writes the end of an XML tag that has no child elements.

Must be used in combination with writeNoChildren only.

Specified by:
writeEndNoChildren in interface Writer

writeNoChildren

public void writeNoChildren(String tagName,
                            String value)
Writes an XML tag with no attributes but with a body text that does not have child elements.
Specified by:
writeNoChildren in interface Writer
Parameters:
tagName - The name of the tag to write.
value - The element's body content.

writePreamble

public void writePreamble()
Writes the XML preamble.
Specified by:
writePreamble in interface Writer

StAXWriter.java 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.