org.apache.juneau.httppart

Class HttpPart

java.lang.Object

org.apache.juneau.httppart.HttpPart

public class HttpPart
extends Object

Represents an instance of an HTTP part.

Can be used to represent both request and response parts.

Constructor Summary

Constructors

Constructor and Description
HttpPart(String name, HttpPartType partType, HttpPartSchema schema, HttpPartParser parser, ParserSessionArgs args, String part) Constructor.
HttpPart(String name, HttpPartType partType, HttpPartSchema schema, HttpPartSerializer serializer, SerializerSessionArgs args, Object part) Constructor.

Method Summary

Modifier and Type	Method and Description
String	asString() Returns the value of the part converted to a string.
<T> T	asType(Class<T> c) Returns the value of the part converted to a string.
String	getName() Returns the name of the part.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HttpPart

public HttpPart(String name,
                HttpPartType partType,
                HttpPartSchema schema,
                HttpPartSerializer serializer,
                SerializerSessionArgs args,
                Object part)

Constructor.

Used when the part is in POJO form and needs to be converted to a String.

Parameters:

name - The HTTP part name (e.g. the header name).

partType - The HTTP part type.

schema - Schema information about the part.

serializer - The part serializer to use to serialize the part.

args - Session arguments to pass to the serializer.

part - The part POJO being serialized.

HttpPart

public HttpPart(String name,
                HttpPartType partType,
                HttpPartSchema schema,
                HttpPartParser parser,
                ParserSessionArgs args,
                String part)

Constructor.

Used when the part is in String form and needs to be converted to a POJO.

Parameters:

name - The HTTP part name (e.g. the header name).

partType - The HTTP part type.

schema - Schema information about the part.

parser - The part parser to use to parse the part.

args - Session arguments to pass to the parser.

part - The part string being parsed.

Method Detail

getName

public String getName()

Returns the name of the part.

Returns:

The name of the part.

asString

public String asString()
                throws SchemaValidationException,
                       SerializeException

Returns the value of the part converted to a string.

Returns:

The value of the part converted to a string.

Throws:

SchemaValidationException - HTTP part failed schema validation.

SerializeException - HTTP part could not be serialized.

asType

public <T> T asType(Class<T> c)
             throws SchemaValidationException,
                    ParseException

Returns the value of the part converted to a string.

Parameters:

c - The type to convert to.

Returns:

The value of the part converted to a string.

Throws:

SchemaValidationException - HTTP part failed schema validation.

ParseException - Malformed input encountered.