org.basex.io.serial

Class OutputSerializer

java.lang.Object

org.basex.io.serial.Serializer

org.basex.io.serial.OutputSerializer

Direct Known Subclasses:

DOTSerializer, 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

elem, level, PROPS, tags, undecl

Method Summary

Methods

Modifier and Type	Method and Description
void	atomic(Item it) Serializes an atomic value.
void	attribute(byte[] n, byte[] v) Serializes an attribute.
void	close() Closes the serializer.
void	closeResult() Closes a result.
protected void	code(int ch) Encodes the specified character before printing it.
protected boolean	ct(boolean empty, boolean html) Prints the content type declaration.
protected void	doctype(byte[] dt) Prints the document type declaration.
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.
protected void	hex(int ch) Returns a hex entity for the specified character.
protected void	indent() Indents the next text.
void	openDoc(byte[] n) Opens a document.
void	openResult() Starts a result.
protected void	print(byte[] token) Writes a token in the current encoding.
protected void	print(int ch) Writes a character in the current encoding.
protected void	print(java.lang.String s) Writes a string in the current encoding.
protected void	printChar(int ch) Writes a character in the current encoding.
void	reset() Resets the serializer (indentation, etc).
protected void	startOpen(byte[] t) Starts an element.

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

closeDoc, closeElement, get, get, namespace, serialize, serialize, startElement

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.

Overrides:

finishText in class Serializer

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

atomic

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

Description copied from class: Serializer

Serializes an atomic value.

Specified by:

atomic in class Serializer

Parameters:

it - item

Throws:

java.io.IOException - I/O exception

openDoc

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

Description copied from class: Serializer

Opens a document.

Overrides:

openDoc in class Serializer

Parameters:

n - name

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

code

protected void code(int ch)
             throws java.io.IOException

Encodes the specified character before printing it.

Parameters:

ch - character to be encoded and printed

Throws:

java.io.IOException - I/O exception

doctype

protected void doctype(byte[] dt)
                throws java.io.IOException

Prints the document type declaration.

Parameters:

dt - document type, or null for html type

Throws:

java.io.IOException - I/O exception

indent

protected final void indent()
                     throws java.io.IOException

Indents the next text.

Throws:

java.io.IOException - I/O exception

hex

protected final void hex(int ch)
                  throws java.io.IOException

Returns a hex entity for the specified character.

Parameters:

ch - character

Throws:

java.io.IOException - I/O exception

printChar

protected final void printChar(int ch)
                        throws java.io.IOException

Writes a character in the current encoding. Converts newlines to the operating system default.

Parameters:

ch - character to be printed

Throws:

java.io.IOException - I/O exception

print

protected void print(int ch)
              throws java.io.IOException

Writes a character in the current encoding.

Parameters:

ch - character to be printed

Throws:

java.io.IOException - I/O exception

print

protected final void print(byte[] token)
                    throws java.io.IOException

Writes a token in the current encoding.

Parameters:

token - token to be printed

Throws:

java.io.IOException - I/O exception

print

protected final void print(java.lang.String s)
                    throws java.io.IOException

Writes a string in the current encoding.

Parameters:

s - string to be printed

Throws:

java.io.IOException - I/O exception

ct

protected boolean ct(boolean empty,
         boolean html)
              throws java.io.IOException

Prints the content type declaration.

Parameters:

empty - empty flag

html - method

Returns:

true if declaration was printed

Throws:

java.io.IOException - I/O exception