org.proteios.io
Interface XMLCrudeWriter3

All Superinterfaces:

XMLCrudeWriter, XMLCrudeWriter2

All Known Implementing Classes:

XMLCrudeWriter3Impl

public interface XMLCrudeWriter3
extends XMLCrudeWriter2

This interface defines crude XML writing, with some added convenience methods. This interface contains some methods that may help writing XML files. It was created as support for e.g. writing single tags with XMLStreamWriter could not be found. It is up to the implementations to decide on indentation, which may be ignored if desired, but if guidelines are requested, recommended use is as follows: To get consistent indentation and change to a new line, the following rules are used: 1. A start element or comment starts a new line. 2. An end element starts a new line, unless following data. 3. Indentation level is increased by one before start element. 4. Indentation level is decreased by one after end element. To avoid having the outermost element block indented, the indentation level starts at -1 instead of 0.

Version:

2.0

Author:

Olle

Last modified

$Date: 2009-04-07 11:17:04 +0200 (Tue, 07 Apr 2009) $

Method Summary

int	getIndentationLevel() Get indentation level.
void	setIndentationLevel(int level) Set indentation level.
void	writeIndentedText(String text, int extraIndentation) Writes indented text with optional extra indentation.

Methods inherited from interface org.proteios.io.XMLCrudeWriter2

writeEndTag, writeSimpleElementPair, writeStartListTag, writeStartTag

Methods inherited from interface org.proteios.io.XMLCrudeWriter

close, flush, getOutStream, isIndentationUsed, setIndentationUsed, setOutStream, writeAttribute, writeCharacters, writeComment, writeEndDocument, writeEndElement, writeNamespace, writeSingleElementEnd, writeStartDocument, writeStartElement, writeStartElementEnd

Method Detail

writeIndentedText

void writeIndentedText(String text,
                       int extraIndentation)
                       throws javax.xml.stream.XMLStreamException

Writes indented text with optional extra indentation. The indentation level counter is not updated.

Parameters:

text - String with text.

extraIndentation - int optional extra indentation.

Throws:

javax.xml.stream.XMLStreamException - If there is an error

getIndentationLevel

int getIndentationLevel()

Get indentation level.

Returns:

int level the indentation level.

setIndentationLevel

void setIndentationLevel(int level)

Set indentation level.

Parameters:

level - int The indentation level to set.