Top Description Fields Constructors Methods
org.apache.catalina.util

public Class XMLWriter

extends Object
Class Inheritance
Imports
java.io.IOException, .Writer, org.apache.tomcat.util.security.Escape
XMLWriter helper class.

Field Summary

Modifier and TypeField and Description
protected StringBuilder
buffer

Buffer.

public static final int
CLOSING

Closing tag.

protected boolean
lastWriteWasOpen

public static final int
NO_CONTENT

Element with no content.

public static final int
OPENING

Opening tag.

protected final Writer
writer

Writer.

Constructor Summary

AccessConstructor and Description
public
XMLWriter()

New XML writer utility that will store its data in an internal buffer.

public
XMLWriter(Writer
The writer to use
writer)

New XML writer utility that will store its data in an internal buffer and can write it to the specified writer.

Method Summary

Modifier and TypeMethod and Description
public void
sendData()

Send data and reinitializes buffer, if a writer has been specified.

public String

Returns:

String containing the generated XML
toString()

Overrides java.lang.Object.toString.

Retrieve generated XML.

public void
writeData(String
Data to append
data)

Write data.

public void
writeElement(String
Namespace abbreviation
namespace, String
Element name
name, int
Element type
type)

Write an element.

public void
writeElement(String
Namespace abbreviation
namespace, String
Namespace info
namespaceInfo, String
Element name
name, int
Element type
type)

Write an element.

public void
writeProperty(String
Namespace
namespace, String
Property name
name, String
Property value
value)

Write property to the XML.

public void
writeRaw(String
Raw XML to append
raw)

Write raw XML data.

public void
writeText(String
Text to append
text)

Write text.

public void
writeXMLHeader()

Write XML Header.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAllwaitwaitwait

Field Detail

bufferback to summary
protected StringBuilder buffer

Buffer.

CLOSINGback to summary
public static final int CLOSING

Closing tag.

lastWriteWasOpenback to summary
protected boolean lastWriteWasOpen
NO_CONTENTback to summary
public static final int NO_CONTENT

Element with no content.

OPENINGback to summary
public static final int OPENING

Opening tag.

writerback to summary
protected final Writer writer

Writer.

Constructor Detail

XMLWriterback to summary
public XMLWriter()

New XML writer utility that will store its data in an internal buffer.

XMLWriterback to summary
public XMLWriter(Writer writer)

New XML writer utility that will store its data in an internal buffer and can write it to the specified writer.

See sendData()

Parameters
writer:Writer

The writer to use

Method Detail

sendDataback to summary
public void sendData() throws IOException

Send data and reinitializes buffer, if a writer has been specified.

Exceptions
IOException:
Error writing XML data
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Retrieve generated XML.

Returns:String

String containing the generated XML

Annotations
@Override
writeDataback to summary
public void writeData(String data)

Write data.

Parameters
data:String

Data to append

writeElementback to summary
public void writeElement(String namespace, String name, int type)

Write an element.

Parameters
namespace:String

Namespace abbreviation

name:String

Element name

type:int

Element type

writeElementback to summary
public void writeElement(String namespace, String namespaceInfo, String name, int type)

Write an element.

Parameters
namespace:String

Namespace abbreviation

namespaceInfo:String

Namespace info

name:String

Element name

type:int

Element type

writePropertyback to summary
public void writeProperty(String namespace, String name, String value)

Write property to the XML.

Parameters
namespace:String

Namespace

name:String

Property name

value:String

Property value

writeRawback to summary
public void writeRaw(String raw)

Write raw XML data.

Parameters
raw:String

Raw XML to append

writeTextback to summary
public void writeText(String text)

Write text.

Parameters
text:String

Text to append

writeXMLHeaderback to summary
public void writeXMLHeader()

Write XML Header.