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 static org.apache.juneau.internal.IOUtils.*;
016
017import java.io.IOException;
018
019import org.apache.juneau.*;
020import org.apache.juneau.collections.*;
021import org.apache.juneau.parser.*;
022
023/**
024 * Session object that lives for the duration of a single use of {@link PlainTextParser}.
025 *
026 * <p>
027 * This class is NOT thread safe.
028 * It is typically discarded after one-time use although it can be reused against multiple inputs.
029 */
030public class PlainTextParserSession extends ReaderParserSession {
031
032   /**
033    * Create a new session using properties specified in the context.
034    *
035    * @param ctx
036    *    The parser creating this session object.
037    *    The parser contains all the configuration settings for this object.
038    * @param args
039    *    Runtime session arguments.
040    */
041   protected PlainTextParserSession(PlainTextParser ctx, ParserSessionArgs args) {
042      super(ctx, args);
043   }
044
045   @Override /* ParserSession */
046   protected <T> T doParse(ParserPipe pipe, ClassMeta<T> type) throws IOException, ParseException, ExecutableException {
047      return convertToType(read(pipe.getReader()), type);
048   }
049
050   //-----------------------------------------------------------------------------------------------------------------
051   // Other methods
052   //-----------------------------------------------------------------------------------------------------------------
053
054   @Override /* Session */
055   public OMap toMap() {
056      return super.toMap()
057         .a("PlainTextParserSession", new DefaultFilteringOMap()
058         );
059   }
060}