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