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.xmlschema;
014
015import org.apache.juneau.serializer.*;
016import org.apache.juneau.xml.*;
017
018/**
019 * Session object that lives for the duration of a single use of {@link XmlSchemaDocSerializer}.
020 *
021 * <p>
022 * This class is NOT thread safe.
023 * It is typically discarded after one-time use although it can be reused within the same thread.
024 */
025public class XmlSchemaDocSerializerSession extends XmlSchemaSerializerSession {
026
027   /**
028    * Create a new session using properties specified in the context.
029    *
030    * @param ctx
031    *    The context creating this session object.
032    *    The context contains all the configuration settings for this object.
033    * @param args
034    *    Runtime arguments.
035    *    These specify session-level information such as locale and URI context.
036    *    It also include session-level properties that override the properties defined on the bean and
037    *    serializer contexts.
038    */
039   protected XmlSchemaDocSerializerSession(XmlSchemaDocSerializer ctx, SerializerSessionArgs args) {
040      super(ctx, args);
041   }
042
043   @Override /* SerializerSession */
044   protected void doSerialize(SerializerPipe out, Object o) throws Exception {
045      try (XmlWriter w = getXmlWriter(out)) {
046         w.append("<?xml")
047            .attr("version", "1.0")
048            .attr("encoding", "UTF-8")
049            .appendln("?>");
050         w.flush();
051         super.doSerialize(out, o);
052      }
053   }
054}