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.plaintext;
014
015import java.io.IOException;
016
017import org.apache.juneau.*;
018import org.apache.juneau.collections.*;
019import org.apache.juneau.serializer.*;
020
021/**
022 * Session object that lives for the duration of a single use of {@link PlainTextSerializer}.
023 *
024 * <p>
025 * This class is NOT thread safe.
026 * It is typically discarded after one-time use although it can be reused within the same thread.
027 */
028public class PlainTextSerializerSession extends WriterSerializerSession {
029
030   /**
031    * Create a new session using properties specified in the context.
032    *
033    * @param ctx
034    *    The context creating this session object.
035    *    The context contains all the configuration settings for this object.
036    * @param args
037    *    Runtime arguments.
038    *    These specify session-level information such as locale and URI context.
039    *    It also include session-level properties that override the properties defined on the bean and
040    *    serializer contexts.
041    */
042   protected PlainTextSerializerSession(PlainTextSerializer ctx, SerializerSessionArgs args) {
043      super(ctx, args);
044   }
045
046   @Override /* SerializerSession */
047   protected void doSerialize(SerializerPipe out, Object o) throws IOException, SerializeException {
048      out.getWriter().write(o == null ? "null" : convertToType(o, String.class));
049   }
050
051   //-----------------------------------------------------------------------------------------------------------------
052   // Other methods
053   //-----------------------------------------------------------------------------------------------------------------
054
055   @Override /* Session */
056   public OMap toMap() {
057      return super.toMap()
058         .a("PlainTextSerializerSession", new DefaultFilteringOMap()
059      );
060   }
061}