org.eclipse.rdf4j.rio.helpers.XMLWriterSettings Maven / Gradle / Ivy
/*******************************************************************************
* Copyright (c) 2015 Eclipse RDF4J contributors, Aduna, and others.
*
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Distribution License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/org/documents/edl-v10.php.
*
* SPDX-License-Identifier: BSD-3-Clause
*******************************************************************************/
package org.eclipse.rdf4j.rio.helpers;
import org.eclipse.rdf4j.rio.RDFWriter;
import org.eclipse.rdf4j.rio.RioSetting;
/**
* A class encapsulating writer settings that XML writers may support.
*
* @author Peter Ansell
*/
public class XMLWriterSettings {
/**
* Boolean setting for XML Writer to determine whether the XML PI (Processing Instruction) should be printed. If
* this setting is disabled the user must have previously printed the XML PI before calling
* {@link RDFWriter#startRDF()} for the document to be valid XML.
*
* Defaults to true.
*
* Can be overridden by setting system property {@code org.eclipse.rdf4j.rio.include_xml_pi}
*
* @see RDF/XML
* specification
*/
public static final BooleanRioSetting INCLUDE_XML_PI = new BooleanRioSetting(
"org.eclipse.rdf4j.rio.include_xml_pi", "Include XML Processing Instruction", Boolean.TRUE);
/**
* Boolean setting for RDF/XML Writer to determine whether the rdf:RDF root tag is to be written. The tag is
* optional in the RDF/XML specification, but a standalone RDF/XML document typically includes it.
*
* Defaults to true.
*
* Can be overridden by setting system property {@code org.eclipse.rdf4j.rio.include_root_rdf_tag}
*
* @see RDF/XML
* specification
*/
public static final BooleanRioSetting INCLUDE_ROOT_RDF_TAG = new BooleanRioSetting(
"org.eclipse.rdf4j.rio.include_root_rdf_tag", "Include Root RDF Tag", Boolean.TRUE);
/**
* Boolean setting for RDF/XML Writer to determine if single quotes are used to quote attribute values. By default
* double quotes are used.
*
* Defaults to false.
*
* Can be overridden by setting system property {@code org.eclipse.rdf4j.rio.use_single_quotes}
*/
public static final BooleanRioSetting USE_SINGLE_QUOTES = new BooleanRioSetting(
"org.eclipse.rdf4j.rio.use_single_quotes", "Use single quotes", Boolean.FALSE);
/**
* Boolean setting for RDF/XML Writer to determine if the character used to quote attribute values, (single quote or
* double quote) is also replaced within text nodes by it's corresponding entity.
*
*
* Defaults to false.
*
* Can be overridden by setting system property {@code org.eclipse.rdf4j.rio.quotes_to_entities_in_text}
*/
public static final BooleanRioSetting QUOTES_TO_ENTITIES_IN_TEXT = new BooleanRioSetting(
"org.eclipse.rdf4j.rio.quotes_to_entities_in_text", "Use single quotes", Boolean.FALSE);
/**
* Private default constructor.
*/
private XMLWriterSettings() {
}
}