com.feilong.lib.xstream.io.xml.AbstractDocumentWriter 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) 2006, 2007, 2009, 2011 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 18. October 2007 by Joerg Schaible
*/
package com.feilong.lib.xstream.io.xml;
import java.util.ArrayList;
import java.util.List;
import com.feilong.lib.xstream.core.util.FastStack;
import com.feilong.lib.xstream.io.naming.NameCoder;
/**
* A generic {@link com.feilong.lib.xstream.io.HierarchicalStreamWriter} for DOM writer
* implementations. The implementation manages a list of top level DOM nodes. Every time the
* last node is closed on the node stack, the next started node is added to the list. This list
* can be retrieved using the {@link DocumentWriter#getTopLevelNodes()} method.
*
* @author Laurent Bihanic
* @author Jörg Schaible
* @since 1.2.1
*/
public abstract class AbstractDocumentWriter extends AbstractXmlWriter implements DocumentWriter{
private final List result = new ArrayList();
private final FastStack nodeStack = new FastStack(16);
/**
* Constructs an AbstractDocumentWriter.
*
* @param container
* the top level container for the nodes to create (may be
* null
)
* @param nameCoder
* the object that creates XML-friendly names
* @since 1.4
*/
public AbstractDocumentWriter(final Object container, final NameCoder nameCoder){
super(nameCoder);
if (container != null){
nodeStack.push(container);
result.add(container);
}
}
@Override
public final void startNode(final String name){
final Object node = createNode(name);
nodeStack.push(node);
}
/**
* Create a node. The provided node name is not yet XML friendly. If {@link #getCurrent()}
* returns null
the node is a top level node.
*
* @param name
* the node name
* @return the new node
* @since 1.2.1
*/
protected abstract Object createNode(String name);
@Override
public final void endNode(){
endNodeInternally();
final Object node = nodeStack.pop();
if (nodeStack.size() == 0){
result.add(node);
}
}
/**
* Called when a node ends. Hook for derived implementations.
*
* @since 1.2.1
*/
public void endNodeInternally(){
}
/**
* @since 1.2.1
*/
protected final Object getCurrent(){
return nodeStack.peek();
}
@Override
public List getTopLevelNodes(){
return result;
}
@Override
public void flush(){
// don't need to do anything
}
@Override
public void close(){
// don't need to do anything
}
}