org.jibx.ws.io.XmlOptions Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2007-2009, Sosnoski Software Associates Limited. All rights reserved.
 * 
 * Redistribution and use 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. Neither the name of
 * JiBX nor the names of its contributors may 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.
 */

package org.jibx.ws.io;

/**
 * Defines options for the encoding, XML declaration and formatting of the XML message.
 * 
 * @author Nigel Charman
 */
public final class XmlOptions
{
    private XmlEncoding m_encoding;
    private Boolean m_standaloneDecl;
    private boolean m_includeEncodingDecl;
    private char m_indentChar;
    private int m_indentCount;
    private String m_newLine;
    
    /**
     * Default constructor for UTF-8, with no formatting and XML declaration containing XML version only.
     */
    public XmlOptions() {
        setEncoding(XmlEncoding.UTF_8);
        setIncludeEncodingDecl(false);
        setStandaloneDecl(null);
        setIndentChar(' ');
        setIndentCount(-1);     // disables formatting
    }

    /**
     * Copy constructor.
     * 
     * @param options the options to copy
     */
    public XmlOptions(XmlOptions options) {
        setEncoding(options.getEncoding());
        setIncludeEncodingDecl(options.isIncludeEncodingDecl());
        setStandaloneDecl(options.getStandaloneDecl());
        setIndentCount(options.getIndentCount());
        setIndentChar(options.getIndentChar());
        setNewLine(options.getNewLine());
    }

    /**
     * Construct with specified encoding, no formatting and XML declaration containing XML version only.
     *  
     * @param encoding the encoding to apply to the message
     */
    public XmlOptions(XmlEncoding encoding) {
        this();
        setEncoding(encoding);
    }
    
    /**
     * Construct with specified encoding and XML declaration, with no formatting.
     *  
     * @param encoding the encoding to apply to the message
     * @param includeEncodingDecl true to include the encoding in the XML declaration, false
     * omits the encoding in the XML declaration.  
     * @param standaloneDecl true to include standalone="yes" in the XML declaration, 
     * false to include standalone="no" in the XML declaration, null to exclude 
     * the standalone attribute from the XML declaration,
     */
    public XmlOptions(XmlEncoding encoding, boolean includeEncodingDecl, Boolean standaloneDecl) {
        
        this(encoding);
        setIncludeEncodingDecl(includeEncodingDecl);
        setStandaloneDecl(standaloneDecl);
    }
    
    /**
     * Construct with message formatting details.
     *  
     * @param indentChar the whitespace character to use for indenting XML.
     * @param indentCount how many indentChars to indent by, disable
     * indentation if negative (zero means new line only)
     * @param newLine sequence of characters used for a line ending
     * (null means use the single character '\n')
     */
    public XmlOptions(char indentChar, int indentCount, String newLine) {
        this();
        setIndentChar(indentChar);
        setIndentCount(indentCount);
        setNewLine(newLine);
    }

    /**
     * Construct with specified message encoding and formatting, with default XML declaration containing XML version 
     * only.
     *  
     * @param encoding the encoding to apply to the message
     * @param indentChar the whitespace character to use for indenting XML.
     * @param indentCount how many indentChars to indent by, disable
     * indentation if negative (zero means new line only)
     * @param newLine sequence of characters used for a line ending
     * (null means use the single character '\n')
     */
    public XmlOptions(XmlEncoding encoding, char indentChar, int indentCount, String newLine) {
        this(encoding);
        setIndentChar(indentChar);
        setIndentCount(indentCount);
        setNewLine(newLine);
    }

    /**
     * Construct with specified message encoding, formatting and XML declaration.
     *  
     * @param encoding the encoding to apply to the message
     * @param includeEncodingDecl true to include the encoding in the XML declaration, false
     * omits the encoding in the XML declaration.  
     * @param standaloneDecl true to include standalone="yes" in the XML declaration, 
     * false to include standalone="no" in the XML declaration, null to exclude 
     * the standalone attribute from the XML declaration
     * @param indentChar the whitespace character to use for indenting XML
     * @param indentCount how many indentChars to indent by, disable
     * indentation if negative (zero means new line only)
     * @param newLine sequence of characters used for a line ending
     * (null means use the single character '\n')
     */
    public XmlOptions(XmlEncoding encoding, boolean includeEncodingDecl, Boolean standaloneDecl, char indentChar,
            int indentCount, String newLine) {
        this(encoding);
        setIncludeEncodingDecl(includeEncodingDecl);
        setStandaloneDecl(standaloneDecl);
        setIndentChar(indentChar);
        setIndentCount(indentCount);
        setNewLine(newLine);
    }

    /**
     * Gets the encoding to use for the message.
     *
     * @return encoding to use
     */
    public XmlEncoding getEncoding() {
        return m_encoding;
    }

    /**
     * Sets the encoding to use for the message.
     *
     * @param encoding to use
     */
    public void setEncoding(XmlEncoding encoding) {
        m_encoding = encoding;
    }
       
    /**
     * Get the number of indent characters to indent the XML by. Disables indentation if negative (zero means new line
     * only).
     * 
     * @return indentCount
     */
    public int getIndentCount() {
        return m_indentCount;
    }

    /**
     * Set the number of indent characters to indent the XML by. Disables indentation if negative (zero means new line
     * only).
     * 
     * @param indentCount the number of indent characters
     */
    public void setIndentCount(int indentCount) {
        m_indentCount = indentCount;
    }

    /**
     * Get the character to use for indenting the XML.
     * 
     * @return indentChar
     */
    public char getIndentChar() {
        return m_indentChar;
    }

    /**
     * Set the character to use for indenting the XML.
     * 
     * @param indentChar the indent character
     */
    public void setIndentChar(char indentChar) {
        m_indentChar = indentChar;
    }

    /**
     * Get the string to use for new lines.
     * 
     * @return newLine
     */
    public String getNewLine() {
        return m_newLine;
    }

    /**
     * Set the string to use for new lines.
     * 
     * @param newLine the new line separator
     */
    public void setNewLine(String newLine) {
        m_newLine = newLine;
    }

    /**
     * Get the setting for the standalone attribute of the XML declaration. 
     * 
     * @return true to include standalone="yes" in the XML declaration, 
     * false to include standalone="no" in the XML declaration, null to exclude 
     * the standalone attribute from the XML declaration,
     */
    public Boolean getStandaloneDecl() {
        return m_standaloneDecl;
    }

    /**
     * Set the standalone attribute of the XML declaration. 
     * 
     * @param standaloneDecl true to include standalone="yes" in the XML declaration, 
     * false to include standalone="no" in the XML declaration, null to exclude 
     * the standalone attribute from the XML declaration,
     * 
     */
    public void setStandaloneDecl(Boolean standaloneDecl) {
        m_standaloneDecl = standaloneDecl;
    }

    /**
     * Get the setting for whether to include the encoding attribute in the XML declaration. 
     *
     * @return true to include the encoding in the XML declaration, false to omit the encoding
     * in the XML declaration.
     */
    public boolean isIncludeEncodingDecl() {
        return m_includeEncodingDecl;
    }

    /**
     * Set whether to include the encoding attribute in the XML declaration.
     *
     * @param includeEncodingDecl true to include the encoding in the XML declaration, false 
     * to omit the encoding in the XML declaration.
     */
    public void setIncludeEncodingDecl(boolean includeEncodingDecl) {
        m_includeEncodingDecl = includeEncodingDecl;
    }
    
    /**
     * Returns the value of the encoding attribute for the XML declaration.
     *
     * @return the value of the encoding attribute, null for no encoding attribute.
     */
    public String getEncodingDeclString() {
        if (m_includeEncodingDecl) {
            return m_encoding.toString();
        }
        return null;
    }

    /**
     * Returns the value of the standalone attribute for the XML declaration.
     *
     * @return the value of the standalone attribute, null for no standalone attribute.
     */
    public String getStandaloneDeclString() {
        if (m_standaloneDecl == null) {
            return null;
        } else if (m_standaloneDecl.equals(Boolean.TRUE)) {
            return "yes";
        } else {
            return "no";
        }
    }
}