org.bedework.util.xml

Class XmlEmit

java.lang.Object

org.bedework.util.xml.XmlEmit

public class XmlEmit
extends Object

Class to emit XML

Author:

Mike Douglass douglm@bedework.edu

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XmlEmit.NameSpace
static class	XmlEmit.Notifier Called (frequently) if set.

Constructor Summary

Constructors

Constructor and Description
XmlEmit() construct an object which will be used to collect namespace names during the first phase and emit xml after startEmit is called.
XmlEmit(boolean noHeaders) construct an object which will be used to collect namespace names during the first phase and emit xml after startEmit is called.

Method Summary

Modifier and Type	Method and Description
void	addNs(XmlEmit.NameSpace val, boolean makeDefaultNs) Called before we start to emit any tags.
void	attribute(QName attr, String attrVal) Add an attribute
void	attribute(String attrName, String attrVal) Add an attribute
void	cdataProperty(QName tag, String val) Create the sequence val
void	cdataValue(String val) Create the sequence val
void	closeTag(QName tag)
void	closeTagNoblanks(QName tag)
void	closeTagSameLine(QName tag)
void	emptyTag(QName tag)
void	emptyTag(QName tag, String attrName, String attrVal)
void	emptyTagSameLine(QName tag)
void	endEmptyTag() End an empty tag
void	endOpeningTag() End a tag we are opening
void	flush()
XmlEmit.NameSpace	getNameSpace(String ns)
String	getNsAbbrev(String ns)
String	getProperty(String name)
Writer	getWriter() Return the underlying writer.
void	newline() Write a new line
void	openTag(QName tag)
void	openTag(QName tag, String attrName, String attrVal) open with attribute
void	openTagNoNewline(QName tag)
void	openTagNoNewline(QName tag, String attrName, String attrVal)
void	openTagSameLine(QName tag)
void	openTagSameLine(QName tag, String attrName, String attrVal) Emit an opening tag ready for nested values.
void	property(QName tag, Reader val) Create the sequence val where val is represented by a Reader
void	property(QName tag, String val) Create the sequence val
void	propertyTagVal(QName tag, QName tagVal) Create the sequence
void	setNotifier(XmlEmit.Notifier n) At the moment fairly primitive - no stacking etc.
void	setProperty(String name, String val) Allows applications to provide parameters to methods using this object class,
void	startEmit(Writer wtr) Emit any headers and namespace declarations
void	startEmit(Writer wtr, String dtd) Emit any headers, dtd and namespace declarations
void	startTag(QName tag) Start tag ready for attributes
void	startTagIndent(QName tag) Start tag ready for attributes - new line and indent
void	startTagSameLine(QName tag) Start a tag ready for some attributes.
void	value(String val) Write out a value

Methods inherited from class java.lang.Object

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

Constructor Detail

XmlEmit

public XmlEmit()

construct an object which will be used to collect namespace names during the first phase and emit xml after startEmit is called.

XmlEmit

public XmlEmit(boolean noHeaders)

construct an object which will be used to collect namespace names during the first phase and emit xml after startEmit is called.

Parameters:

noHeaders - boolean true to suppress headers

Method Detail

setProperty

public void setProperty(String name,
                        String val)

Allows applications to provide parameters to methods using this object class,

For example, a parameter "full" with value "true" might indicate a full XML dump is required.

Parameters:

name -

val -

getProperty

public String getProperty(String name)

Parameters:

name -

Returns:

value or null

startEmit

public void startEmit(Writer wtr)
               throws IOException

Emit any headers and namespace declarations

Parameters:

wtr -

Throws:

IOException

startEmit

public void startEmit(Writer wtr,
                      String dtd)
               throws IOException

Emit any headers, dtd and namespace declarations

Parameters:

wtr -

dtd -

Throws:

IOException

setNotifier

public void setNotifier(XmlEmit.Notifier n)

At the moment fairly primitive - no stacking etc.

Parameters:

n -

openTag

public void openTag(QName tag)
             throws IOException

Parameters:

tag -

Throws:

IOException

openTag

public void openTag(QName tag,
                    String attrName,
                    String attrVal)
             throws IOException

open with attribute

Parameters:

tag -

attrName -

attrVal -

Throws:

IOException

openTagNoNewline

public void openTagNoNewline(QName tag)
                      throws IOException

Parameters:

tag -

Throws:

IOException

openTagNoNewline

public void openTagNoNewline(QName tag,
                             String attrName,
                             String attrVal)
                      throws IOException

Parameters:

tag -

attrName -

attrVal -

Throws:

IOException

openTagSameLine

public void openTagSameLine(QName tag)
                     throws IOException

Parameters:

tag -

Throws:

IOException

openTagSameLine

public void openTagSameLine(QName tag,
                            String attrName,
                            String attrVal)
                     throws IOException

Emit an opening tag ready for nested values. No new line

Parameters:

tag -

attrName -

attrVal -

Throws:

IOException

startTag

public void startTag(QName tag)
              throws IOException

Start tag ready for attributes

Parameters:

tag -

Throws:

IOException

startTagIndent

public void startTagIndent(QName tag)
                    throws IOException

Start tag ready for attributes - new line and indent

Parameters:

tag -

Throws:

IOException

startTagSameLine

public void startTagSameLine(QName tag)
                      throws IOException

Start a tag ready for some attributes. No new line

Parameters:

tag -

Throws:

IOException

endOpeningTag

public void endOpeningTag()
                   throws IOException

End a tag we are opening

Throws:

IOException

attribute

public void attribute(String attrName,
                      String attrVal)
               throws IOException

Add an attribute

Parameters:

attrName -

attrVal -

Throws:

IOException

attribute

public void attribute(QName attr,
                      String attrVal)
               throws IOException

Add an attribute

Parameters:

attr -

attrVal -

Throws:

IOException

closeTag

public void closeTag(QName tag)
              throws IOException

Parameters:

tag -

Throws:

IOException

closeTagNoblanks

public void closeTagNoblanks(QName tag)
                      throws IOException

Parameters:

tag -

Throws:

IOException

closeTagSameLine

public void closeTagSameLine(QName tag)
                      throws IOException

Parameters:

tag -

Throws:

IOException

endEmptyTag

public void endEmptyTag()
                 throws IOException

End an empty tag

Throws:

IOException

emptyTag

public void emptyTag(QName tag)
              throws IOException

Parameters:

tag -

Throws:

IOException

emptyTag

public void emptyTag(QName tag,
                     String attrName,
                     String attrVal)
              throws IOException

Parameters:

tag -

attrName -

attrVal -

Throws:

IOException

emptyTagSameLine

public void emptyTagSameLine(QName tag)
                      throws IOException

Parameters:

tag -

Throws:

IOException

property

public void property(QName tag,
                     String val)
              throws IOException

Create the sequence
val

Parameters:

tag -

val -

Throws:

IOException

cdataProperty

public void cdataProperty(QName tag,
                          String val)
                   throws IOException

Create the sequence
val

Parameters:

tag -

val -

Throws:

IOException

property

public void property(QName tag,
                     Reader val)
              throws IOException

Create the sequence
val where val is represented by a Reader

Parameters:

tag -

val -

Throws:

IOException

propertyTagVal

public void propertyTagVal(QName tag,
                           QName tagVal)
                    throws IOException

Create the sequence

Parameters:

tag -

tagVal -

Throws:

IOException

cdataValue

public void cdataValue(String val)
                throws IOException

Create the sequence
val

Parameters:

val -

Throws:

IOException

value

public void value(String val)
           throws IOException

Write out a value

Parameters:

val -

Throws:

IOException

getWriter

public Writer getWriter()

Return the underlying writer. Should only be used to emit values.

Returns:

- the writer

flush

public void flush()
           throws IOException

Throws:

IOException

addNs

public void addNs(XmlEmit.NameSpace val,
                  boolean makeDefaultNs)
           throws IOException

Called before we start to emit any tags.

Parameters:

val -

makeDefaultNs - - true => make this the default

Throws:

IOException

getNameSpace

public XmlEmit.NameSpace getNameSpace(String ns)

Parameters:

ns -

Returns:

NameSpace if present

getNsAbbrev

public String getNsAbbrev(String ns)

Parameters:

ns -

Returns:

namespace abrev

newline

public void newline()
             throws IOException

Write a new line

Throws:

IOException