XMLWriter (Nuxeo ECM Projects 8.2 API)

java.lang.Object
- org.nuxeo.apidoc.introspection.XMLWriter

```
public class XMLWriter
extends Object
```
This file contains code from org.apache.commons.betwixt.XMLUtils

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`AMPERSAND_ENTITY`
`static String`	`APOSTROPHE_ENTITY`
`protected String`	`crlf`
`protected static String`	`CRLF`
`protected int`	`depth`
`protected org.nuxeo.apidoc.introspection.XMLWriter.Element`	`element`
`protected boolean`	`emitHeader`
`protected String`	`encoding`
`protected ArrayList<String>`	`globalNsMap`
`static String`	`GREATER_THAN_ENTITY`
`protected int`	`indent`
`static String`	`LESS_THAN_ENTITY`
`static String`	`QUOTE_ENTITY`
`protected Writer`	`writer`

Constructor Summary

Constructors
Constructor and Description
`XMLWriter(Writer writer)`
`XMLWriter(Writer writer, int indent)`
`XMLWriter(Writer writer, int indent, String crlf)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`XMLWriter`	`attr(QName name)`
`XMLWriter`	`attr(QName name, Object value)`
`XMLWriter`	`attr(String name)`
`XMLWriter`	`attr(String name, Object value)`
`XMLWriter`	`bool(QName name, boolean value)`
`XMLWriter`	`bool(String name, boolean value)`
`void`	`close()`
`XMLWriter`	`content(boolean value)`
`XMLWriter`	`content(Date value)`
`XMLWriter`	`content(String text)`
`XMLWriter`	`date(Date value)`
`XMLWriter`	`date(QName name, Date value)`
`XMLWriter`	`date(String name, Date value)`
`protected void`	`done()`
`XMLWriter`	`eattr(QName name, Object value)`
`XMLWriter`	`eattr(String name, Object value)`
`XMLWriter`	`econtent(String text)`
`XMLWriter`	`element(QName name)`
`XMLWriter`	`element(String name)`
`XMLWriter`	`end()`
`static String`	`escapeAttributeValue(Object value)` Escape the `toString` of the given object.
`static String`	`escapeBodyValue(Object value)` Escape the `toString` of the given object.
`XMLWriter`	`etext(String text)`
`void`	`flush()`
`static String`	`format(Date date)`
`String`	`getCRLF()`
`String`	`getEncoding()`
`int`	`getIndent()`
`Writer`	`getWriter()`
`String`	`getXmlNs(String uri)`
`void`	`indent(String text)`
`XMLWriter`	`integer(long value)`
`XMLWriter`	`integer(QName name, long value)`
`XMLWriter`	`integer(String name, long value)`
`boolean`	`isEmitHeader()`
`XMLWriter`	`number(double value)`
`XMLWriter`	`number(QName name, double value)`
`XMLWriter`	`number(String name, double value)`
`XMLWriter`	`object(Object value)`
`void`	`putXmlns(String uri)`
`void`	`putXmlns(String prefix, String uri)`
`String`	`resolve(QName name)`
`void`	`setCRLF(String crlf)`
`void`	`setEmitHeader(boolean emitHeader)`
`void`	`setEncoding(String encoding)`
`void`	`setIndent(int indent)`
`void`	`setWriter(Writer writer)`
`XMLWriter`	`start()`
`XMLWriter`	`string(String value)`
`XMLWriter`	`text(String text)`
`XMLWriter`	`write(String text)`
`XMLWriter`	`xmlns(String value)`
`XMLWriter`	`xmlns(String name, String value)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CRLF
```
protected static final String CRLF
```

indent
```
protected int indent
```

writer
```
protected Writer writer
```

crlf
```
protected String crlf
```

emitHeader
```
protected boolean emitHeader
```

encoding
```
protected String encoding
```

globalNsMap

protected ArrayList<String> globalNsMap

element

protected org.nuxeo.apidoc.introspection.XMLWriter.Element element

depth
```
protected int depth
```

LESS_THAN_ENTITY

public static final String LESS_THAN_ENTITY

See Also:: Constant Field Values

GREATER_THAN_ENTITY

public static final String GREATER_THAN_ENTITY

See Also:: Constant Field Values

AMPERSAND_ENTITY

public static final String AMPERSAND_ENTITY

See Also:: Constant Field Values

APOSTROPHE_ENTITY

public static final String APOSTROPHE_ENTITY

See Also:: Constant Field Values

QUOTE_ENTITY

public static final String QUOTE_ENTITY

See Also:: Constant Field Values

Constructor Detail

XMLWriter
```
public XMLWriter(Writer writer)
```

XMLWriter

public XMLWriter(Writer writer,
                 int indent)

XMLWriter

public XMLWriter(Writer writer,
                 int indent,
                 String crlf)

Method Detail

setEncoding

public void setEncoding(String encoding)

getEncoding
```
public String getEncoding()
```

putXmlns
```
public void putXmlns(String uri)
```

putXmlns

public void putXmlns(String prefix,
                     String uri)

getXmlNs
```
public String getXmlNs(String uri)
```

setIndent
```
public void setIndent(int indent)
```

getIndent
```
public int getIndent()
```

setCRLF
```
public void setCRLF(String crlf)
```

getCRLF
```
public String getCRLF()
```

setWriter
```
public void setWriter(Writer writer)
```

getWriter
```
public Writer getWriter()
```

setEmitHeader

public void setEmitHeader(boolean emitHeader)

isEmitHeader
```
public boolean isEmitHeader()
```

flush

public void flush()
           throws IOException

Throws:: IOException

close

public void close()
           throws IOException

Throws:: IOException

done

protected void done()
             throws IOException

Throws:: IOException

write

public XMLWriter write(String text)
                throws IOException

Throws:: IOException

indent

public void indent(String text)
            throws IOException

Throws:: IOException

element

public XMLWriter element(String name)
                  throws IOException

Throws:: IOException

start

public XMLWriter start()
                throws IOException

Throws:: IOException

end

public XMLWriter end()
              throws IOException

Throws:: IOException

content

public XMLWriter content(String text)
                  throws IOException

Throws:: IOException

econtent

public XMLWriter econtent(String text)
                   throws IOException

Throws:: IOException

content

public XMLWriter content(boolean value)
                  throws IOException

Throws:: IOException

content

public XMLWriter content(Date value)
                  throws IOException

Throws:: IOException

text

public XMLWriter text(String text)
               throws IOException

Throws:: IOException

etext

public XMLWriter etext(String text)
                throws IOException

Throws:: IOException

attr

public XMLWriter attr(String name,
                      Object value)
               throws IOException

Throws:: IOException

eattr

public XMLWriter eattr(String name,
                       Object value)
                throws IOException

Throws:: IOException

xmlns

public XMLWriter xmlns(String value)
                throws IOException

Throws:: IOException

xmlns

public XMLWriter xmlns(String name,
                       String value)
                throws IOException

Throws:: IOException

attr

public XMLWriter attr(String name)
               throws IOException

Throws:: IOException

string

public XMLWriter string(String value)
                 throws IOException

Throws:: IOException

object

public XMLWriter object(Object value)
                 throws IOException

Throws:: IOException

date

public XMLWriter date(Date value)
               throws IOException

Throws:: IOException

integer

public XMLWriter integer(long value)
                  throws IOException

Throws:: IOException

number

public XMLWriter number(double value)
                 throws IOException

Throws:: IOException

bool

public XMLWriter bool(String name,
                      boolean value)
               throws IOException

Throws:: IOException

integer

public XMLWriter integer(String name,
                         long value)
                  throws IOException

Throws:: IOException

number

public XMLWriter number(String name,
                        double value)
                 throws IOException

Throws:: IOException

date

public XMLWriter date(String name,
                      Date value)
               throws IOException

Throws:: IOException

resolve
```
public String resolve(QName name)
```

element

public XMLWriter element(QName name)
                  throws IOException

Throws:: IOException

attr

public XMLWriter attr(QName name,
                      Object value)
               throws IOException

Throws:: IOException

eattr

public XMLWriter eattr(QName name,
                       Object value)
                throws IOException

Throws:: IOException

attr

public XMLWriter attr(QName name)
               throws IOException

Throws:: IOException

bool

public XMLWriter bool(QName name,
                      boolean value)
               throws IOException

Throws:: IOException

integer

public XMLWriter integer(QName name,
                         long value)
                  throws IOException

Throws:: IOException

number

public XMLWriter number(QName name,
                        double value)
                 throws IOException

Throws:: IOException

date

public XMLWriter date(QName name,
                      Date value)
               throws IOException

Throws:: IOException

format

public static String format(Date date)

escapeBodyValue
```
public static final String escapeBodyValue(Object value)
```
Escape the toString of the given object. For use as body text.

Parameters:

value - escape value.toString()

Returns:

text with escaped delimiters

escapeAttributeValue
```
public static final String escapeAttributeValue(Object value)
```
Escape the toString of the given object. For use in an attribute value.

Parameters:

value - escape value.toString()

Returns:

text with characters restricted (for use in attributes) escaped

Class XMLWriter

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CRLF

indent

writer

crlf

emitHeader

encoding

globalNsMap

element

depth

LESS_THAN_ENTITY

GREATER_THAN_ENTITY

AMPERSAND_ENTITY

APOSTROPHE_ENTITY

QUOTE_ENTITY

Constructor Detail

XMLWriter

XMLWriter

XMLWriter

Method Detail

setEncoding

getEncoding

putXmlns

putXmlns

getXmlNs

setIndent

getIndent

setCRLF

getCRLF

setWriter

getWriter

setEmitHeader

isEmitHeader

flush

close

done

write

indent

element

start

end

content

econtent

content

content

text

etext

attr

eattr

xmlns

xmlns

attr

string

object

date

integer

number

bool

integer

number

date

resolve

element

attr

eattr

attr

bool

integer

number

date

format

escapeBodyValue

escapeAttributeValue