net.sf.saxon.option.expath.zip.library.Serialization Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of saxon-he Show documentation
An OSGi bundle for Saxon-HE
There is a newer version: 10.5
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
// Copyright (c) 2013 Saxonica Limited.
// This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0.
// If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
// This Source Code Form is "Incompatible With Secondary Licenses", as defined by the Mozilla Public License, v. 2.0.
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

package net.sf.saxon.option.expath.zip.library;

import net.sf.saxon.trans.XPathException;

import javax.xml.transform.OutputKeys;
import java.util.Properties;

/**
 * Represent a set of serialization parameters.
 *
 * @author Florent Georges
 * @date   2010-02-14
 */
public class Serialization
{
    /**
     * Return a serialization parameters map usable with JAXP.
     */
    public Properties getOutputOptions()
            throws XPathException
    {
        if ( myMethod == null ) {
            throw new ZipException("The method serialization param is not set");
        }
        return myOptions;
    }

    /**
     * Return the {@code method} serialization param if set, {@code null} otherwise.
     */
    public String getMethod()
    {
        return myMethod;
    }

    /**
     * Set a serialization parameter, given its name and its value.
     */
    public void setOutputParam(String name, String value)
            throws ZipException
    {
        if ( "method".equals(name) ) {
            if ( value != null && ! ("text".equals(value)
                     || "xml".equals(value) || "html".equals(value)
                     || "xhtml".equals(value) || "base64".equals(value)
                     || "hex".equals(value)) ) {
                throw new ZipException("Invalid value for the method serialization param: " + value);
            }
            myMethod = value;
            setProperty(OutputKeys.METHOD, value);
        }
        else if ( "indent".equals(name) ) {
            setProperty(OutputKeys.INDENT, value);
        }
        else if ( "media-type".equals(name) ) {
            setProperty(OutputKeys.MEDIA_TYPE, value);
        }
        // TODO: There is no std constant in JAXP for this.  How to do?  For now
        // supported in SaxonSerialization, but it should be supported here...
        // else if ( "byte-order-mark".equals(name) ) {
        //     setProperty(OutputKeys., value);
        // }
        else if ( "cdata-section-elements".equals(name) ) {
            setProperty(OutputKeys.CDATA_SECTION_ELEMENTS, value);
        }
        else if ( "doctype-public".equals(name) ) {
            setProperty(OutputKeys.DOCTYPE_PUBLIC, value);
        }
        else if ( "doctype-system".equals(name) ) {
            setProperty(OutputKeys.DOCTYPE_SYSTEM, value);
        }
        else if ( "encoding".equals(name) ) {
            setProperty(OutputKeys.ENCODING, value);
        }
        // TODO: There is no std constant in JAXP for this.  How to do?  For now
        // supported in SaxonSerialization, but it should be supported here...
        // else if ( "escape-uri-uttributes".equals(name) ) {
        //     setProperty(OutputKeys., value);
        // }
        // else if ( "normalization-form".equals(name) ) {
        //     setProperty(OutputKeys., value);
        // }
        else if ( "omit-xml-declaration".equals(name) ) {
            setProperty(OutputKeys.OMIT_XML_DECLARATION, value);
        }
        else if ( "standalone".equals(name) ) {
            setProperty(OutputKeys.STANDALONE, value);
        }
        // TODO: There is no std constant in JAXP for this.  How to do?  For now
        // supported in SaxonSerialization, but it should be supported here...
        // else if ( "suppress-indentation".equals(name) ) {
        //     setProperty(OutputKeys., value);
        // }
        // else if ( "undeclare-prefixes".equals(name) ) {
        //     setProperty(OutputKeys., value);
        // }
        else if ( "version".equals(name) ) {
            setProperty(OutputKeys.VERSION, value);
        }
        else {
            throw new ZipException("Unknown serialization paramater: " + name + " (value: " + value + ")");
        }
    }

    protected void setProperty(String prop, String value)
    {
        myOptions.put(prop, value);
    }

    private Properties myOptions = new Properties();
    private String     myMethod  = null;
}