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.csv;
018
019import java.io.*;
020import java.lang.reflect.*;
021import java.nio.charset.*;
022import java.util.*;
023import java.util.function.*;
024
025import org.apache.juneau.*;
026import org.apache.juneau.httppart.*;
027import org.apache.juneau.internal.*;
028import org.apache.juneau.parser.*;
029
030/**
031 * Session object that lives for the duration of a single use of {@link CsvParser}.
032 *
033 * <h5 class='section'>Notes:</h5><ul>
034 *    <li class='warn'>This class is not thread safe and is typically discarded after one use.
035 * </ul>
036 *
037 * <h5 class='section'>See Also:</h5><ul>
038
039 * </ul>
040 */
041public class CsvParserSession extends ReaderParserSession {
042
043   //-------------------------------------------------------------------------------------------------------------------
044   // Static
045   //-------------------------------------------------------------------------------------------------------------------
046
047   /**
048    * Creates a new builder for this object.
049    *
050    * @param ctx The context creating this session.
051    * @return A new builder.
052    */
053   public static Builder create(CsvParser ctx) {
054      return new Builder(ctx);
055   }
056
057   //-------------------------------------------------------------------------------------------------------------------
058   // Builder
059   //-------------------------------------------------------------------------------------------------------------------
060
061   /**
062    * Builder class.
063    */
064   public static class Builder extends ReaderParserSession.Builder {
065
066      CsvParser ctx;
067
068      /**
069       * Constructor
070       *
071       * @param ctx The context creating this session.
072       */
073      protected Builder(CsvParser ctx) {
074         super(ctx);
075         this.ctx = ctx;
076      }
077
078      @Override
079      public CsvParserSession build() {
080         return new CsvParserSession(this);
081      }
082      @Override /* Overridden from Builder */
083      public <T> Builder apply(Class<T> type, Consumer<T> apply) {
084         super.apply(type, apply);
085         return this;
086      }
087
088      @Override /* Overridden from Builder */
089      public Builder debug(Boolean value) {
090         super.debug(value);
091         return this;
092      }
093
094      @Override /* Overridden from Builder */
095      public Builder properties(Map<String,Object> value) {
096         super.properties(value);
097         return this;
098      }
099
100      @Override /* Overridden from Builder */
101      public Builder property(String key, Object value) {
102         super.property(key, value);
103         return this;
104      }
105
106      @Override /* Overridden from Builder */
107      public Builder unmodifiable() {
108         super.unmodifiable();
109         return this;
110      }
111
112      @Override /* Overridden from Builder */
113      public Builder locale(Locale value) {
114         super.locale(value);
115         return this;
116      }
117
118      @Override /* Overridden from Builder */
119      public Builder localeDefault(Locale value) {
120         super.localeDefault(value);
121         return this;
122      }
123
124      @Override /* Overridden from Builder */
125      public Builder mediaType(MediaType value) {
126         super.mediaType(value);
127         return this;
128      }
129
130      @Override /* Overridden from Builder */
131      public Builder mediaTypeDefault(MediaType value) {
132         super.mediaTypeDefault(value);
133         return this;
134      }
135
136      @Override /* Overridden from Builder */
137      public Builder timeZone(TimeZone value) {
138         super.timeZone(value);
139         return this;
140      }
141
142      @Override /* Overridden from Builder */
143      public Builder timeZoneDefault(TimeZone value) {
144         super.timeZoneDefault(value);
145         return this;
146      }
147
148      @Override /* Overridden from Builder */
149      public Builder javaMethod(Method value) {
150         super.javaMethod(value);
151         return this;
152      }
153
154      @Override /* Overridden from Builder */
155      public Builder outer(Object value) {
156         super.outer(value);
157         return this;
158      }
159
160      @Override /* Overridden from Builder */
161      public Builder schema(HttpPartSchema value) {
162         super.schema(value);
163         return this;
164      }
165
166      @Override /* Overridden from Builder */
167      public Builder schemaDefault(HttpPartSchema value) {
168         super.schemaDefault(value);
169         return this;
170      }
171
172      @Override /* Overridden from Builder */
173      public Builder fileCharset(Charset value) {
174         super.fileCharset(value);
175         return this;
176      }
177
178      @Override /* Overridden from Builder */
179      public Builder streamCharset(Charset value) {
180         super.streamCharset(value);
181         return this;
182      }
183   }
184
185   //-------------------------------------------------------------------------------------------------------------------
186   // Instance
187   //-------------------------------------------------------------------------------------------------------------------
188
189   /**
190    * Constructor.
191    *
192    * @param builder The builder for this object.
193    */
194   protected CsvParserSession(Builder builder) {
195      super(builder);
196   }
197
198   @Override /* ParserSession */
199   protected <T> T doParse(ParserPipe pipe, ClassMeta<T> type) throws IOException, ParseException {
200      try (ParserReader r = pipe.getParserReader()) {
201         if (r == null)
202            return null;
203         return parseAnything(type, r, getOuter(), null);
204      }
205   }
206
207   private <T> T parseAnything(ClassMeta<T> eType, ParserReader r, Object outer, BeanPropertyMeta pMeta) throws ParseException {
208      throw new ParseException("Not implemented.");
209   }
210}