com.feilong.lib.xstream.io.HierarchicalStreamWriter Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of feilong Show documentation
Show all versions of feilong Show documentation
feilong is a suite of core and expanded libraries that include utility classes, http, excel,cvs, io classes, and much much more.
/*
* Copyright (C) 2004, 2005 Joe Walnes.
* Copyright (C) 2006, 2007 XStream Committers.
* All rights reserved.
*
* The software in this package is published under the terms of the BSD
* style license a copy of which has been included with this distribution in
* the LICENSE.txt file.
*
* Created on 07. March 2004 by Joe Walnes
*/
package com.feilong.lib.xstream.io;
/**
* @author Joe Walnes
*/
public interface HierarchicalStreamWriter{
void startNode(String name);
void addAttribute(String name,String value);
/**
* Write the value (text content) of the current node.
*/
void setValue(String text);
void endNode();
/**
* Flush the writer, if necessary.
*/
void flush();
/**
* Close the writer, if necessary.
*/
void close();
/**
* 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.
*
*/
HierarchicalStreamWriter underlyingWriter();
}