XmlRetainingSink (Requirement Yogi 3.0.0 API)

java.lang.Object
- com.playsql.utils.xml.XmlRetainingSink

All Implemented Interfaces:

XMLEventConsumer, XMLEventWriter
```
public class XmlRetainingSink
extends Object
implements XMLEventWriter
```
It's an XMLWriter which can suspend writing until a later event. It can be used when you know you have some XML to insert at some place, but you need to read the next events (ex: the rest of the table row) before knowing what to insert. It can also be used when you want to check whether a will only contain whitespace, and eventually not write it into the output.

Field Summary

Fields
Modifier and Type Field and Description

private List<XMLEvent> retainedElements

private XMLEventWriter xmlWriter

Fields
Modifier and Type	Field and Description
`private List<XMLEvent>`	`retainedElements`
`private XMLEventWriter`	`xmlWriter`

Constructor Summary

Constructors
Constructor and Description

XmlRetainingSink(XMLEventWriter xmlWriter)

Constructors
Constructor and Description
`XmlRetainingSink(XMLEventWriter xmlWriter)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(XMLEvent event)`
`void`	`add(XMLEventReader reader)`
`void`	`addDespiteRetainment(XMLEvent event)`
`void`	`close()`
`void`	`flush()`
`NamespaceContext`	`getNamespaceContext()`
`String`	`getPrefix(String uri)`
`List<XMLEvent>`	`getRetainedElements()`
`boolean`	`isRetaining()`
`XMLEventWriter`	`parent()`
`void`	`setDefaultNamespace(String uri)`
`void`	`setNamespaceContext(NamespaceContext context)`
`void`	`setPrefix(String prefix, String uri)`
`void`	`startRetaining()`
`void`	`stopRetaining(boolean flush)`
`String`	`toString()`

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

Field Detail

xmlWriter
```
private final XMLEventWriter xmlWriter
```

retainedElements

private List<XMLEvent> retainedElements

Constructor Detail

XmlRetainingSink

public XmlRetainingSink(XMLEventWriter xmlWriter)

Method Detail

add
```
public void add(XMLEvent event)
         throws XMLStreamException
```
Specified by:

add in interface XMLEventConsumer

Specified by:

add in interface XMLEventWriter

Throws:

XMLStreamException

startRetaining

public void startRetaining()
                    throws XMLStreamException

Throws:: XMLStreamException

addDespiteRetainment

public void addDespiteRetainment(XMLEvent event)
                          throws XMLStreamException

Throws:: XMLStreamException

stopRetaining

public void stopRetaining(boolean flush)
                   throws XMLStreamException

Throws:: XMLStreamException

isRetaining
```
public boolean isRetaining()
```

parent
```
public XMLEventWriter parent()
```

toString
```
public String toString()
```
Overrides:

toString in class Object

flush
```
public void flush()
           throws XMLStreamException
```
Specified by:

flush in interface XMLEventWriter

Throws:

XMLStreamException

add

public void add(XMLEventReader reader)
         throws XMLStreamException

Specified by:: add in interface XMLEventWriter
Throws:: XMLStreamException

getPrefix

public String getPrefix(String uri)
                 throws XMLStreamException

Specified by:: getPrefix in interface XMLEventWriter
Throws:: XMLStreamException

setPrefix

public void setPrefix(String prefix,
                      String uri)
               throws XMLStreamException

Specified by:: setPrefix in interface XMLEventWriter
Throws:: XMLStreamException

setDefaultNamespace
```
public void setDefaultNamespace(String uri)
                         throws XMLStreamException
```
Specified by:

setDefaultNamespace in interface XMLEventWriter

Throws:

XMLStreamException

setNamespaceContext

public void setNamespaceContext(NamespaceContext context)
                         throws XMLStreamException

Specified by:: setNamespaceContext in interface XMLEventWriter
Throws:: XMLStreamException

getNamespaceContext
```
public NamespaceContext getNamespaceContext()
```
Specified by:

getNamespaceContext in interface XMLEventWriter

close
```
public void close()
           throws XMLStreamException
```
Specified by:

close in interface XMLEventWriter

Throws:

XMLStreamException

getRetainedElements

public List<XMLEvent> getRetainedElements()

Class XmlRetainingSink

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

xmlWriter

retainedElements

Constructor Detail

XmlRetainingSink

Method Detail

add

startRetaining

addDespiteRetainment

stopRetaining

isRetaining

parent

toString

flush

add

getPrefix

setPrefix

setDefaultNamespace

setNamespaceContext

getNamespaceContext

close

getRetainedElements