org.apache.juneau.httppart

Interface HttpPartParserSession

All Known Implementing Classes:

BaseHttpPartParserSession, OpenApiParserSession, SimplePartParserSession, UonParserSession, UrlEncodingParserSession

public interface HttpPartParserSession

Session object that lives for the duration of a single use of HttpPartParser.

This class is NOT thread safe. It is typically discarded after one-time use although it can be reused within the same thread.

Method Summary

Modifier and Type	Method and Description
<T> T	parse(HttpPartSchema schema, String in, Class<T> toType) Same as parse(HttpPartType, HttpPartSchema, String, Class) but defaults to a null part type.
<T> T	parse(HttpPartSchema schema, String in, ClassMeta<T> toType) Same as parse(HttpPartType, HttpPartSchema, String, ClassMeta) but defaults to a null part type.
<T> T	parse(HttpPartSchema schema, String in, Type toType, Type... toTypeArgs) Same as parse(HttpPartType, HttpPartSchema, String, Type, Type...) but defaults to a null part type.
<T> T	parse(HttpPartType partType, HttpPartSchema schema, String in, Class<T> toType) Converts the specified input to the specified class type.
<T> T	parse(HttpPartType partType, HttpPartSchema schema, String in, ClassMeta<T> toType) Converts the specified input to the specified class type.
<T> T	parse(HttpPartType partType, HttpPartSchema schema, String in, Type toType, Type... toTypeArgs) Converts the specified input to the specified class type.

Method Detail

parse

<T> T parse(HttpPartType partType,
            HttpPartSchema schema,
            String in,
            ClassMeta<T> toType)
     throws ParseException,
            SchemaValidationException

Converts the specified input to the specified class type.

Parameters:

partType - The part type being parsed.

schema - Schema information about the part.
May be null.
Not all part parsers use the schema information.

in - The input being parsed.

toType - The POJO type to transform the input into.

Returns:

The parsed value.

Throws:

ParseException - Malformed input encountered.

SchemaValidationException - If the input or resulting HTTP part object fails schema validation.

parse

<T> T parse(HttpPartType partType,
            HttpPartSchema schema,
            String in,
            Class<T> toType)
     throws ParseException,
            SchemaValidationException

Converts the specified input to the specified class type.

Parameters:

partType - The part type being parsed.

schema - Schema information about the part.
May be null.
Not all part parsers use the schema information.

in - The input being parsed.

toType - The POJO type to transform the input into.

Returns:

The parsed value.

Throws:

ParseException - Malformed input encountered.

SchemaValidationException - If the input or resulting HTTP part object fails schema validation.

parse

<T> T parse(HttpPartType partType,
            HttpPartSchema schema,
            String in,
            Type toType,
            Type... toTypeArgs)
     throws ParseException,
            SchemaValidationException

Converts the specified input to the specified class type.

Parameters:

partType - The part type being parsed.

schema - Schema information about the part.
May be null.
Not all part parsers use the schema information.

in - The input being parsed.

toType - The POJO type to transform the input into.

toTypeArgs - The POJO type arguments for Collection and Map types.

Returns:

The parsed value.

Throws:

ParseException - Malformed input encountered.

SchemaValidationException - If the input or resulting HTTP part object fails schema validation.

parse

<T> T parse(HttpPartSchema schema,
            String in,
            ClassMeta<T> toType)
     throws ParseException,
            SchemaValidationException

Same as parse(HttpPartType, HttpPartSchema, String, ClassMeta) but defaults to a null part type.

Parameters:

schema - Schema information about the part.
May be null.
Not all part parsers use the schema information.

in - The input being parsed.

toType - The POJO type to transform the input into.

Returns:

The parsed value.

Throws:

ParseException - Malformed input encountered.

SchemaValidationException - If the input or resulting HTTP part object fails schema validation.

parse

<T> T parse(HttpPartSchema schema,
            String in,
            Class<T> toType)
     throws ParseException,
            SchemaValidationException

Same as parse(HttpPartType, HttpPartSchema, String, Class) but defaults to a null part type.

Parameters:

schema - Schema information about the part.
May be null.
Not all part parsers use the schema information.

in - The input being parsed.

toType - The POJO type to transform the input into.

Returns:

The parsed value.

Throws:

ParseException - Malformed input encountered.

SchemaValidationException - If the input or resulting HTTP part object fails schema validation.

parse

<T> T parse(HttpPartSchema schema,
            String in,
            Type toType,
            Type... toTypeArgs)
     throws ParseException,
            SchemaValidationException

Same as parse(HttpPartType, HttpPartSchema, String, Type, Type...) but defaults to a null part type.

Parameters:

schema - Schema information about the part.
May be null.
Not all part parsers use the schema information.

in - The input being parsed.

toType - The POJO type to transform the input into.

toTypeArgs - The POJO type arguments for Collection and Map types.

Returns:

The parsed value.

Throws:

ParseException - Malformed input encountered.

SchemaValidationException - If the input or resulting HTTP part object fails schema validation.