ikr.simlib.result

Interface ResultWriter

All Known Subinterfaces:

PrintResultWriter

All Known Implementing Classes:

CompactingResultWriter, PrintResultFilterWriter, XMLResultWriter

public interface ResultWriter

This interface allows serial output of result trees. This is the most basic way to write results and no formatting or keyword handling is applied.

Comments can be written anywhere to the result tree but might not be supported by implementations and are always skipped by result readers. They can however increase readability in certain cases.

Result names are optional.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closes the writer and underlying streams.
void	writeDouble(java.lang.String name, double value) A shorthand method for
void	writeEndArray() Writes the end of a result array.
void	writeEndArrayItem() Writes the end of a result array bucket.
void	writeEndNode() Writes the end of a result node.
void	writeEndResults() Writes the end of the results.
void	writeLong(java.lang.String name, long value) A shorthand method for
void	writeStartArray(java.lang.String name) Writes the beginning of a result array.
void	writeStartArrayItem(int index) Writes the beginning of a result array bucket.
void	writeStartNode(java.lang.String type, java.lang.String name) Writes the beginning of a result node.
void	writeStartResults() Writes the beginning of the results.
void	writeString(java.lang.String name, java.lang.String value) A shorthand method for

Method Detail

close

void close()
           throws ResultException

Closes the writer and underlying streams.

Throws:

ResultException

writeStartResults

void writeStartResults()
                       throws ResultException

Writes the beginning of the results. In order to complete the results the user must call writeEndResults .

Throws:

ResultException - if any error in writing the results occurs

java.lang.IllegalStateException - if result output has started already

writeEndResults

void writeEndResults()
                     throws ResultException

Writes the end of the results. It must be preceded by a call to writeStartResults and all other writeStartXXX must have been matched by their writeEndXXX counterparts.

Throws:

ResultException - if any error in writing the results occurs

java.lang.IllegalStateException - if any started result hasn't been ended yet

writeStartNode

void writeStartNode(java.lang.String type,
                  java.lang.String name)
                    throws ResultException

Writes the beginning of a result node. In order to complete the node the user must call writeEndNode.

Parameters:

type - of the result node

Throws:

ResultException - if any error in writing the results occurs

writeEndNode

void writeEndNode()
                  throws ResultException

Writes the end of a result node. It must be preceded by a call to writeStartNode.

Throws:

ResultException - if any error in writing the results occurs

writeStartArray

void writeStartArray(java.lang.String name)
                     throws ResultException

Writes the beginning of a result array. In order to complete the array you must call writeEndArray.

Throws:

ResultException - if any error in writing the results occurs

writeEndArray

void writeEndArray()
                   throws ResultException

Writes the end of a result array. It must be preceded by a call to writeStartArray.

Throws:

ResultException - if any error in writing the results occurs

writeStartArrayItem

void writeStartArrayItem(int index)
                         throws ResultException

Writes the beginning of a result array bucket. In order to complete the bucket you must call writeEndBucket. It is only legal to call this method in an array.

Throws:

ResultException - if any error in writing the results occurs

writeEndArrayItem

void writeEndArrayItem()
                       throws ResultException

Writes the end of a result array bucket. It must be preceded by a call to writeStartBucket.

Throws:

ResultException - if any error in writing the results occurs

writeLong

void writeLong(java.lang.String name,
             long value)
               throws ResultException

A shorthand method for

 <code>
 writeLong(value);
 writeName(name);
 </code>
 

Parameters:

name - name of the result

value - value of the result

Throws:

ResultException - if any error in writing the results occurs

writeDouble

void writeDouble(java.lang.String name,
               double value)
                 throws ResultException

A shorthand method for

 <code>
 writeDouble(value);
 writeName(name);
 </code>
 

Parameters:

name - name of the result

value - value of the result

Throws:

ResultException - if any error in writing the results occurs

writeString

void writeString(java.lang.String name,
               java.lang.String value)
                 throws ResultException

A shorthand method for

 <code>
 writeString(value);
 writeName(name);
 </code>
 

Parameters:

name - name of the result

value - value of the result

Throws:

ResultException - if any error in writing the results occurs