001// ***************************************************************************************************************************
002// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  See the NOTICE file *
003// * distributed with this work for additional information regarding copyright ownership.  The ASF licenses this file        *
004// * to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance            *
005// * with the License.  You may obtain a copy of the License at                                                              *
006// *                                                                                                                         *
007// *  http://www.apache.org/licenses/LICENSE-2.0                                                                             *
008// *                                                                                                                         *
009// * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an  *
010// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the License for the        *
011// * specific language governing permissions and limitations under the License.                                              *
012// ***************************************************************************************************************************
013package org.apache.juneau.xml;
014
015import org.apache.juneau.serializer.*;
016
017/**
018 * Session object that lives for the duration of a single use of {@link XmlSchemaDocSerializer}.
019 * 
020 * <p>
021 * This class is NOT thread safe.
022 * It is typically discarded after one-time use although it can be reused within the same thread.
023 */
024public class XmlSchemaDocSerializerSession extends XmlSchemaSerializerSession {
025
026   /**
027    * Create a new session using properties specified in the context.
028    * 
029    * @param ctx
030    *    The context creating this session object.
031    *    The context contains all the configuration settings for this object.
032    * @param args
033    *    Runtime arguments.
034    *    These specify session-level information such as locale and URI context.
035    *    It also include session-level properties that override the properties defined on the bean and
036    *    serializer contexts.
037    */
038   protected XmlSchemaDocSerializerSession(XmlSchemaDocSerializer ctx, SerializerSessionArgs args) {
039      super(ctx, args);
040   }
041
042   @Override /* SerializerSession */
043   protected void doSerialize(SerializerPipe out, Object o) throws Exception {
044      try (XmlWriter w = getXmlWriter(out)) {
045         w.append("<?xml")
046            .attr("version", "1.0")
047            .attr("encoding", "UTF-8")
048            .appendln("?>");
049         w.flush();
050         super.doSerialize(out, o);
051      }
052   }
053}