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.httppart;
014
015import org.apache.juneau.*;
016import org.apache.juneau.parser.*;
017
018/**
019 * Session object that lives for the duration of a single use of {@link HttpPartParser}.
020 *
021 * <h5 class='section'>Notes:</h5><ul>
022 *    <li class='warn'>This class is not thread safe and is typically discarded after one use.
023 * </ul>
024 *
025 * <h5 class='section'>See Also:</h5><ul>
026 *    <li class='link'><a class="doclink" href="../../../../index.html#jm.HttpPartSerializersParsers">HTTP Part Serializers and Parsers</a>
027 * </ul>
028 */
029public interface HttpPartParserSession {
030
031   /**
032    * Converts the specified input to the specified class type.
033    *
034    * @param <T> The POJO type to transform the input into.
035    * @param partType The part type being parsed.
036    * @param schema
037    *    Schema information about the part.
038    *    <br>May be <jk>null</jk>.
039    *    <br>Not all part parsers use the schema information.
040    * @param in The input being parsed.
041    * @param toType The POJO type to transform the input into.
042    * @return The parsed value.
043    * @throws ParseException Malformed input encountered.
044    * @throws SchemaValidationException If the input or resulting HTTP part object fails schema validation.
045    */
046   public <T> T parse(HttpPartType partType, HttpPartSchema schema, String in, ClassMeta<T> toType) throws ParseException, SchemaValidationException;
047}