org.beanio.stream.xml.XmlParserConfiguration Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of beanio Show documentation
Show all versions of beanio Show documentation
A Java un/marshalling library for CSV, XML, delimited and fixed length stream formats.
/*
* Copyright 2012 Kevin Seim
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.beanio.stream.xml;
import java.util.*;
/**
* Stores configuration settings for parsing XML formatted streams.
*
* By default, indentation is disabled and an XML header will be written to an output stream.
*
* @author Kevin Seim
* @since 2.0
*/
public class XmlParserConfiguration implements Cloneable {
private int indentation = -1;
private String lineSeparator = null;
private boolean suppressHeader = false;
private String version = "1.0";
private String encoding = "utf-8";
/* Map of namespace prefixes to namespace uri's */
private Map namespaceMap = new HashMap<>();
/**
* Returns the number of spaces to indent each level of XML, or -1
* if indentation is disabled.
* @return the number of spaces to indent each level of XML,
* or -1 to disable indentation
*/
public int getIndentation() {
return indentation;
}
/**
* Enables and sets the indentation level in spaces. If set to -1
* (the default value), indentation is disabled.
* @param indentation the number of spaces to indent each level of XML,
* or -1 to disable indentation
*/
public void setIndentation(int indentation) {
this.indentation = indentation;
}
/**
* Returns whether XML output will be indented.
* @return true if indentation is enabled
*/
public boolean isIndentationEnabled() {
return indentation >= 0;
}
/**
* Returns the text used to terminate a line when indentation is enabled.
* When set to null (the default), the line separator is set to the
* value of the line.separator system property.
* @return the line separation text
*/
public String getLineSeparator() {
return lineSeparator;
}
/**
* Sets the text used to terminate a line when indentation is enabled.
* When set to null (the default), the line separator is set to the
* value of the line.separator system property.
* @param lineSeparator the line separation text
*/
public void setLineSeparator(String lineSeparator) {
this.lineSeparator = lineSeparator;
}
/**
* Returns whether the XML header is suppressed. Defaults to false.
* @return true if the XML header is suppressed
*/
public boolean isSuppressHeader() {
return suppressHeader;
}
/**
* Sets whether the XML header is suppressed.
* @param suppressHeader true to suppress the XML header
*/
public void setSuppressHeader(boolean suppressHeader) {
this.suppressHeader = suppressHeader;
}
/**
* Returns the XML version to include in the document header.
* @return the XML version
*/
public String getVersion() {
return version;
}
/**
* Sets the XML version to include in the document header. Defaults to 1.0.
* May not be set to null.
* @param version the XML version
*/
public void setVersion(String version) {
if (version == null) {
throw new IllegalArgumentException("null version");
}
this.version = version;
}
/**
* Returns the XML character encoding to include in the document header.
* @return the XML character encoding
*/
public String getEncoding() {
return encoding;
}
/**
* Sets the XML character encoding to include in the document header. Defaults
* to 'utf-8'. If set to null or empty string the document
* header will not include the encoding setting.
* @param encoding the XML character encoding
*/
public void setEncoding(String encoding) {
this.encoding = encoding;
}
/**
* Adds a namespace to be set on the root element.
* @param prefix the namespace prefix
* @param uri the namespace URI
*/
public void addNamespace(String prefix, String uri) {
if (prefix == null) {
throw new IllegalArgumentException("null prefix");
}
if (uri == null) {
throw new IllegalArgumentException("null uri");
}
namespaceMap.put(uri, prefix);
}
/**
* Sets the list of namespaces to be set on the root element. The list should be formatted
* as a space delimited list of alternating prefixes and uri's. For example,
*
* setNamespaces("xsd http://www.w3.org/2001/XMLSchema b http://www.beanio.org/2011/01");
*
* @param list the space delimited list of namespaces
*/
public void setNamespaces(String list) {
namespaceMap.clear();
if (list == null) {
return;
}
String [] s = list.trim().split("\\s+");
if (s.length % 2 != 0) {
throw new IllegalArgumentException(
"Invalid namespaces setting. Must follow 'prefix uri prefix uri' pattern.");
}
for (int i=0; i getNamespaceMap() {
return namespaceMap;
}
@Override
protected XmlParserConfiguration clone() {
try {
return (XmlParserConfiguration) super.clone();
}
catch (CloneNotSupportedException ex) {
throw new IllegalStateException();
}
}
}