jadex.xml.writer

Class Writer

java.lang.Object

jadex.xml.writer.Writer

Direct Known Subclasses:

JavaWriter

public class Writer
extends Object

XML writer for conversion of objects to XML.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_ENCODING The default encoding.
static String	lf The linefeed separator.
static String	XML_INCLUDE_FIELDS Constant for indicating if public fields should be written.

Constructor Summary

Constructors

Constructor and Description
Writer(IObjectWriterHandler handler) Create a new reader (with genids=true and indent=true).
Writer(IObjectWriterHandler handler, boolean genids) Create a new reader (with genids=true and indent=true).
Writer(IObjectWriterHandler handler, boolean genids, boolean indent) Create a new reader.

Method Summary

Methods

Modifier and Type	Method and Description
static byte[]	objectToByteArray(Writer writer, Object val, ClassLoader classloader) Convert to a byte array.
static byte[]	objectToByteArray(Writer writer, Object val, ClassLoader classloader, Object context) Convert to a byte array.
static String	objectToXML(Writer writer, Object val, ClassLoader classloader) Convert to a string.
static String	objectToXML(Writer writer, Object val, ClassLoader classloader, Object context) Convert to a string.
void	write(Object object, OutputStream out, ClassLoader classloader, Object context) Write the properties to an xml.
void	write(Object object, String encoding, OutputStream out, ClassLoader classloader, Object context) Write the properties to an xml.
void	writeEndObject(XMLStreamWriter writer, int level) Write the end of an object.
void	writeIndentation(XMLStreamWriter writer, int level) Write the indentation.
void	writeObject(WriteContext wc, Object object, QName tag) Write an object to xml.
void	writeStartObject(XMLStreamWriter writer, QName tag, int level) Write the start of an object.

Methods inherited from class java.lang.Object

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

Field Detail

XML_INCLUDE_FIELDS

public static final String XML_INCLUDE_FIELDS

Constant for indicating if public fields should be written. The field has to be declared as public and its value will be used to determine if fields should be included.

See Also:

Constant Field Values

lf

public static final String lf

The linefeed separator.

DEFAULT_ENCODING

public static String DEFAULT_ENCODING

The default encoding.

Constructor Detail

Writer

public Writer(IObjectWriterHandler handler)

Create a new reader (with genids=true and indent=true).

Parameters:

handler - The handler.

Writer

public Writer(IObjectWriterHandler handler,
      boolean genids)

Create a new reader (with genids=true and indent=true).

Parameters:

handler - The handler.

Writer

public Writer(IObjectWriterHandler handler,
      boolean genids,
      boolean indent)

Create a new reader.

Parameters:

handler - The handler.

Method Detail

write

public void write(Object object,
         OutputStream out,
         ClassLoader classloader,
         Object context)
           throws Exception

Write the properties to an xml.

Parameters:

input - The input stream.

classloader - The classloader.

context - The context.

Throws:

Exception

write

public void write(Object object,
         String encoding,
         OutputStream out,
         ClassLoader classloader,
         Object context)
           throws Exception

Write the properties to an xml.

Parameters:

input - The input stream.

classloader - The classloader.

context - The context.

Throws:

Exception

writeObject

public void writeObject(WriteContext wc,
               Object object,
               QName tag)
                 throws Exception

Write an object to xml. Note: Must have tag parameter to support writing an object using an arbitrary tag. Cannot write tag in beforehand, because it must be written in one pass.

Throws:

Exception

writeStartObject

public void writeStartObject(XMLStreamWriter writer,
                    QName tag,
                    int level)
                      throws Exception

Write the start of an object.

Throws:

Exception

writeEndObject

public void writeEndObject(XMLStreamWriter writer,
                  int level)
                    throws Exception

Write the end of an object.

Throws:

Exception

writeIndentation

public void writeIndentation(XMLStreamWriter writer,
                    int level)
                      throws Exception

Write the indentation.

Throws:

Exception

objectToXML

public static String objectToXML(Writer writer,
                 Object val,
                 ClassLoader classloader)

Convert to a string.

objectToXML

public static String objectToXML(Writer writer,
                 Object val,
                 ClassLoader classloader,
                 Object context)

Convert to a string.

objectToByteArray

public static byte[] objectToByteArray(Writer writer,
                       Object val,
                       ClassLoader classloader)

Convert to a byte array.

objectToByteArray

public static byte[] objectToByteArray(Writer writer,
                       Object val,
                       ClassLoader classloader,
                       Object context)

Convert to a byte array.