org.basex.io.serial

Class OutputSerializer

java.lang.Object

org.basex.io.serial.Serializer

org.basex.io.serial.OutputSerializer

Direct Known Subclasses:

DOTSerializer, HTML5Serializer, HTMLSerializer, JsonMLSerializer, JSONSerializer, TextSerializer, XHTMLSerializer, XMLSerializer

public abstract class OutputSerializer
extends Serializer

This class serializes data to an output stream.

Author:

BaseX Team 2005-12, BSD License, Christian Gruen

Field Summary

Fields inherited from class org.basex.io.serial.Serializer

level, PROPS, tag, tags, undecl

Method Summary

Methods

Modifier and Type	Method and Description
void	attribute(byte[] n, byte[] v) Serializes an attribute.
void	close() Closes the serializer.
void	closeResult() Closes a result.
void	finishAtomic(Item it) Serializes an item.
protected void	finishClose() Closes an element.
void	finishComment(byte[] n) Serializes a comment.
boolean	finished() Tests if the serialization was interrupted.
protected void	finishEmpty() Closes an empty element.
protected void	finishOpen() Finishes an opening element node.
void	finishPi(byte[] n, byte[] v) Serializes a processing instruction.
void	finishText(byte[] b) Serializes a text.
void	finishText(byte[] b, FTPos ftp) Serializes a text.
void	openResult() Starts a result.
void	reset() Resets the serializer (indentation, etc).
protected void	startOpen(byte[] t) Starts an element.

Methods inherited from class org.basex.io.serial.Serializer

atomic, closeElement, comment, emptyElement, emptyElement, get, get, namespace, node, node, openElement, openElement, pi, text

Methods inherited from class java.lang.Object

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

Method Detail

reset

public final void reset()

Description copied from class: Serializer

Resets the serializer (indentation, etc).

Overrides:

reset in class Serializer

close

public void close()
           throws java.io.IOException

Description copied from class: Serializer

Closes the serializer.

Overrides:

close in class Serializer

Throws:

java.io.IOException - I/O exception

openResult

public void openResult()
                throws java.io.IOException

Description copied from class: Serializer

Starts a result.

Overrides:

openResult in class Serializer

Throws:

java.io.IOException - I/O exception

closeResult

public void closeResult()
                 throws java.io.IOException

Description copied from class: Serializer

Closes a result.

Overrides:

closeResult in class Serializer

Throws:

java.io.IOException - I/O exception

attribute

public void attribute(byte[] n,
             byte[] v)
               throws java.io.IOException

Description copied from class: Serializer

Serializes an attribute.

Specified by:

attribute in class Serializer

Parameters:

n - name

v - value

Throws:

java.io.IOException - I/O exception

finishText

public void finishText(byte[] b)
                throws java.io.IOException

Description copied from class: Serializer

Serializes a text.

Specified by:

finishText in class Serializer

Parameters:

b - value

Throws:

java.io.IOException - I/O exception

finishText

public void finishText(byte[] b,
              FTPos ftp)
                throws java.io.IOException

Description copied from class: Serializer

Serializes a text.

Parameters:

b - value

ftp - full-text positions, used for visualization highlighting

Throws:

java.io.IOException - I/O exception

finishComment

public void finishComment(byte[] n)
                   throws java.io.IOException

Description copied from class: Serializer

Serializes a comment.

Specified by:

finishComment in class Serializer

Parameters:

n - value

Throws:

java.io.IOException - I/O exception

finishPi

public void finishPi(byte[] n,
            byte[] v)
              throws java.io.IOException

Description copied from class: Serializer

Serializes a processing instruction.

Specified by:

finishPi in class Serializer

Parameters:

n - name

v - value

Throws:

java.io.IOException - I/O exception

finishAtomic

public void finishAtomic(Item it)
                  throws java.io.IOException

Description copied from class: Serializer

Serializes an item.

Specified by:

finishAtomic in class Serializer

Parameters:

it - item

Throws:

java.io.IOException - I/O exception

finished

public final boolean finished()

Description copied from class: Serializer

Tests if the serialization was interrupted.

Overrides:

finished in class Serializer

Returns:

result of check

startOpen

protected void startOpen(byte[] t)
                  throws java.io.IOException

Description copied from class: Serializer

Starts an element.

Specified by:

startOpen in class Serializer

Parameters:

t - tag name

Throws:

java.io.IOException - I/O exception

finishOpen

protected void finishOpen()
                   throws java.io.IOException

Description copied from class: Serializer

Finishes an opening element node.

Specified by:

finishOpen in class Serializer

Throws:

java.io.IOException - I/O exception

finishEmpty

protected void finishEmpty()
                    throws java.io.IOException

Description copied from class: Serializer

Closes an empty element.

Specified by:

finishEmpty in class Serializer

Throws:

java.io.IOException - I/O exception

finishClose

protected void finishClose()
                    throws java.io.IOException

Description copied from class: Serializer

Closes an element.

Specified by:

finishClose in class Serializer

Throws:

java.io.IOException - I/O exception