001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.juneau.marshall.xml;
018
019import java.io.*;
020
021import org.apache.juneau.marshall.*;
022
023/**
024 * Concrete {@link XmlWriter} leaf for standard XML output.
025 *
026 * <p>
027 * This is the directly-instantiable form of {@link XmlWriter}, which is itself an abstract CRTP self-type base so it
028 * can also be extended (e.g. by {@link org.apache.juneau.marshall.html.HtmlWriter}).
029 *
030 * <h5 class='section'>Notes:</h5><ul>
031 *    <li class='note'>
032 *       This class is not intended for external use.
033 * </ul>
034 */
035public final class BasicXmlWriter extends XmlWriter<BasicXmlWriter> {
036
037   /**
038    * Constructor.
039    *
040    * @param out The wrapped writer.
041    * @param useWhitespace If <jk>true</jk> XML elements will be indented.
042    * @param maxIndent The maximum indentation level.
043    * @param trimStrings If <jk>true</jk>, strings should be trimmed before they're serialized.
044    * @param quoteChar The quote character to use for attributes.  Should be <js>'\''</js> or <js>'"'</js>.
045    * @param uriResolver The URI resolver for resolving URIs to absolute or root-relative form.
046    * @param enableNs Flag to indicate if XML namespaces are enabled.
047    * @param defaultNamespace The default namespace if XML namespaces are enabled.
048    */
049   @SuppressWarnings({
050      "java:S107" // Constructor requires 8 parameters for XML writer configuration
051   })
052   public BasicXmlWriter(Writer out, boolean useWhitespace, int maxIndent, boolean trimStrings, char quoteChar, UriResolver uriResolver, boolean enableNs, Namespace defaultNamespace) {
053      super(out, useWhitespace, maxIndent, trimStrings, quoteChar, uriResolver, enableNs, defaultNamespace);
054   }
055}