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