XStream Core 1.4.20 · com.thoughtworks.xstream.io.HierarchicalStreamWriter

Method Summary

Modifier and Type	Method and Description
public void	addAttribute(String name, String value)
public void	close() Close the writer, if necessary.
public void	endNode()
public void	flush() Flush the writer, if necessary.
public void	setValue(String text) Write the value (text content) of the current node.
public void	startNode(String name)
public HierarchicalStreamWriter	underlyingWriter() Return the underlying HierarchicalStreamWriter implementation.

Method Detail

addAttribute	back to summary
public void addAttribute(String name, String value)

close	back to summary
public void close() Close the writer, if necessary.

endNode	back to summary
public void endNode()

flush	back to summary
public void flush() Flush the writer, if necessary.

setValue	back to summary
public void setValue(String text) Write the value (text content) of the current node.

startNode	back to summary
public void startNode(String name)

underlyingWriter	back to summary
public HierarchicalStreamWriter underlyingWriter() Return the underlying HierarchicalStreamWriter implementation. If a Converter needs to access methods of a specific HierarchicalStreamWriter implementation that are not defined in the HierarchicalStreamWriter interface, it should call this method before casting. This is because the writer passed to the Converter is often wrapped/decorated by another implementation to provide additional functionality (such as XPath tracking). For example: MySpecificWriter mySpecificWriter = (MySpecificWriter)writer; // INCORRECT! mySpecificWriter.doSomethingSpecific(); MySpecificWriter mySpecificWriter = (MySpecificWriter)writer.underlyingWriter(); // CORRECT! mySpecificWriter.doSomethingSpecific(); Implementations of HierarchicalStreamWriter should return 'this', unless they are a decorator, in which case they should delegate to whatever they are wrapping.

underlyingWriter

back to summary

public HierarchicalStreamWriter underlyingWriter()

Return the underlying HierarchicalStreamWriter implementation.

If a Converter needs to access methods of a specific HierarchicalStreamWriter implementation that are not defined in the HierarchicalStreamWriter interface, it should call this method before casting. This is because the writer passed to the Converter is often wrapped/decorated by another implementation to provide additional functionality (such as XPath tracking).

For example:

MySpecificWriter mySpecificWriter = (MySpecificWriter)writer; // INCORRECT!
mySpecificWriter.doSomethingSpecific();

MySpecificWriter mySpecificWriter = (MySpecificWriter)writer.underlyingWriter();  // CORRECT!
mySpecificWriter.doSomethingSpecific();

Implementations of HierarchicalStreamWriter should return 'this', unless they are a decorator, in which case they should delegate to whatever they are wrapping.

public Interface HierarchicalStreamWriter

Method Summary

Method Detail