All Downloads are FREE. Search and download functionalities are using the official Maven repository.

info.bliki.htmlcleaner.PrettyXmlSerializer Maven / Gradle / Ivy

Go to download

This is the core project.

The newest version!
/*  Copyright (c) 2006-2007, Vladimir Nikic
    All rights reserved.

    Redistribution and use of this software in source and binary forms,
    with or without modification, are permitted provided that the following
    conditions are met:

    * Redistributions of source code must retain the above
      copyright notice, this list of conditions and the
      following disclaimer.

    * Redistributions in binary form must reproduce the above
      copyright notice, this list of conditions and the
      following disclaimer in the documentation and/or other
      materials provided with the distribution.

    * The name of HtmlCleaner may not be used to endorse or promote
      products derived from this software without specific prior
      written permission.

    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
    AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
    IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
    ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
    LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
    CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
    SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
    INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
    CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
    ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
    POSSIBILITY OF SUCH DAMAGE.

    You can contact Vladimir Nikic by sending e-mail to
    [email protected]. Please include the word "HtmlCleaner" in the
    subject line.
*/

package info.bliki.htmlcleaner;

import java.io.IOException;
import java.io.Writer;
import java.util.Iterator;
import java.util.List;
import java.util.StringTokenizer;

/**
 * 
Pretty XML serializer - creates resulting XML with indenting lines.

 *
 * Created by: Vladimir Nikic

 * Date: November, 2006.
 */
public class PrettyXmlSerializer extends XmlSerializer {

    private static final String INDENTATION_STRING = "\t";

    protected PrettyXmlSerializer(Writer writer, HtmlCleaner htmlCleaner) {
        super(writer, htmlCleaner);
    }

    @Override
    protected void serialize(TagNode tagNode) throws IOException {
        serializePrettyXml(tagNode, 0);
    }

    /**
     * @param level
     * @return Appropriate indentation for the specified depth.
     */
    private String indent(int level) {
        String result = "";
        while (level > 0) {
            result += INDENTATION_STRING;
            level--;
        }

        return result;
    }

    private String getIndentedText(String content,  int level) {
        String indent = indent(level);
        StringBuffer result = new StringBuffer( content.length() );
        StringTokenizer tokenizer = new StringTokenizer(content, "\n\r");

        while (tokenizer.hasMoreTokens()) {
            String line = tokenizer.nextToken().trim();
            if (!"".equals(line)) {
                result.append(indent + line + "\n");
            }
        }

        return result.toString();
    }

    private String getSingleLineOfChildren(List children) {
        StringBuffer result = new StringBuffer();
        Iterator childrenIt = children.iterator();
        boolean isFirst = true;

        while (childrenIt.hasNext()) {
            Object child = childrenIt.next();

            if ( !(child instanceof ContentToken) ) {
                return null;
            } else {
                ContentToken contentToken = (ContentToken) child;
                String content = contentToken.getContent();

                // if first item trims it from left
                if (isFirst) {
                    content = Utils.ltrim(content);
                }

                // if last item trims it from right
                if (!childrenIt.hasNext()) {
                    content = Utils.rtrim(content);
                }

                if ( content.indexOf("\n") >= 0 || content.indexOf("\r") >= 0 ) {
                    return null;
                }
                result.append(content);
            }

            isFirst = false;
        }

        return result.toString();
    }

    private void serializePrettyXml(List nodes, int level, boolean dontEscape) throws IOException {
        Iterator childrenIt = nodes.iterator();
        while (childrenIt.hasNext()) {
            Object child = childrenIt.next();
            if (child instanceof TagNode) {
                serializePrettyXml( (TagNode)child, level + 1 );
            } else if (child instanceof ContentToken) {
                ContentToken contentToken = (ContentToken) child;
                String content = contentToken.getContent();
                if ( !dontEscape ) {
                    content = escapeXml(content);
                } else {
                    content = content.replaceAll("]]>", "]]&");
                }
                writer.write( getIndentedText(content, level + 1) );
            } else if (child instanceof CommentToken) {
                CommentToken commentToken = (CommentToken) child;
                String content = commentToken.getContent();
                writer.write( getIndentedText(content, level + 1) );
            } else if (child instanceof List) {
                @SuppressWarnings("unchecked")
                final List list = (List) child;
                serializePrettyXml(list, level, true );
            }
        }
    }

    protected void serializePrettyXml(TagNode tagNode, int level) throws IOException {
        List tagChildren = tagNode.getChildren();
        String indent = indent(level);

        writer.write(indent);
        serializeOpenTag(tagNode);

        if ( !tagChildren.isEmpty() ) {
            String singleLine = getSingleLineOfChildren(tagChildren);
            boolean dontEscape = dontEscape(tagNode);
            if (singleLine != null) {
                if ( !dontEscape(tagNode) ) {
                    writer.write( escapeXml(singleLine) );
                } else {
                    writer.write( singleLine.replaceAll("]]>", "]]&") );
                }
            } else {
                writer.write("\n");
                serializePrettyXml(tagChildren, level, dontEscape);
            }

            if (singleLine == null) {
                writer.write(indent);
            }

            serializeEndTag(tagNode);
        }
    }

}
 















© 2015 - 2024 Weber Informatics LLC | Privacy Policy