Package org.jxmpp.xml.splitter

Class XmlSplitter

java.lang.Object

java.io.Writer

org.jxmpp.xml.splitter.XmlSplitter

All Implemented Interfaces:

Closeable, Flushable, Appendable, AutoCloseable

Direct Known Subclasses:

XmppXmlSplitter

public class XmlSplitter
extends Writer

A XML splitter capable of splitting XML into top-level elements.

Note that this class does not yet support the feature set of XML. Only the required features for XMPP are supported. XML comments and processing instructions are not supported.

Field Summary

Fields

Modifier and Type	Field	Description
protected final CompleteElementCallback	completeElementCallback

Fields inherited from class java.io.Writer

lock

Constructor Summary

Constructors

Constructor	Description
XmlSplitter(int bufferSize, CompleteElementCallback completeElementCallback)	Construct a new XML splitter.
XmlSplitter(int bufferSize, CompleteElementCallback completeElementCallback, DeclarationCallback declarationCallback, ProcessingInstructionCallback processingInstructionCallback)	Construct a new XML splitter.
XmlSplitter(int bufferSize, CompleteElementCallback completeElementCallback, DeclarationCallback declarationCallback, ProcessingInstructionCallback processingInstructionCallback, XmlPrinter xmlPrinter)	Construct a new XML splitter.
XmlSplitter(int bufferSize, CompleteElementCallback completeElementCallback, XmlPrinter xmlPrinter)	Construct a new XML splitter.

Method Summary

Modifier and Type	Method	Description
void	close()
void	flush()
final int	getCurrentSplittedPartSize()	Get the size in bytes of the splitted part currently being processed.
protected final void	newSplittedPart()
protected void	onEndTag(String qName)
protected void	onNextChar()
protected void	onStartTag(String prefix, String localpart, Map<String,String> attributes)
void	write(char[] cbuf, int off, int len)

Methods inherited from class java.io.Writer

append, append, append, nullWriter, write, write, write, write

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

completeElementCallback

protected final CompleteElementCallback completeElementCallback

Constructor Details

XmlSplitter

public XmlSplitter(int bufferSize,
 CompleteElementCallback completeElementCallback,
 DeclarationCallback declarationCallback,
 ProcessingInstructionCallback processingInstructionCallback)

Construct a new XML splitter.

Parameters:

bufferSize - the initial size of the buffer.

completeElementCallback - the callback invoked once a complete element has been processed.

declarationCallback - a optional callback for the XML declaration.

processingInstructionCallback - a optional callback for Processing Instructions.

XmlSplitter

public XmlSplitter(int bufferSize,
 CompleteElementCallback completeElementCallback,
 XmlPrinter xmlPrinter)

Construct a new XML splitter.

Parameters:

bufferSize - the initial size of the buffer.

completeElementCallback - the callback invoked once a complete element has been processed.

xmlPrinter - an optional XmlPrinter.

XmlSplitter

public XmlSplitter(int bufferSize,
 CompleteElementCallback completeElementCallback)

Construct a new XML splitter.

Parameters:

bufferSize - the initial size of the buffer.

completeElementCallback - the callback invoked once a complete element has been processed.

XmlSplitter

public XmlSplitter(int bufferSize,
 CompleteElementCallback completeElementCallback,
 DeclarationCallback declarationCallback,
 ProcessingInstructionCallback processingInstructionCallback,
 XmlPrinter xmlPrinter)

Construct a new XML splitter.

Parameters:

bufferSize - the initial size of the buffer.

completeElementCallback - the callback invoked once a complete element has been processed.

declarationCallback - a optional callback for the XML declaration.

processingInstructionCallback - a optional callback for Processing Instructions.

xmlPrinter - an optional XmlPrinter.

Method Details

write

public void write(char[] cbuf,
 int off,
 int len)
           throws IOException

Specified by:

write in class Writer

Throws:

IOException

flush

public void flush()

Specified by:

flush in interface Flushable

Specified by:

flush in class Writer

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in class Writer

getCurrentSplittedPartSize

public final int getCurrentSplittedPartSize()

Get the size in bytes of the splitted part currently being processed.

Returns:

the size of the current splitted part in chars.

onNextChar

protected void onNextChar()
                   throws IOException

Throws:

IOException

onStartTag

protected void onStartTag(String prefix,
 String localpart,
 Map<String,String> attributes)

onEndTag

protected void onEndTag(String qName)

newSplittedPart

protected final void newSplittedPart()