org.simpleframework.http.message
Interface PartSeries

public interface PartSeries

The PartSeries object represents an ordered list of parts that were uploaded within a HTTP entity body. This allows the parts to be iterated over, or if required accessed by name. In order to access the Part object by name it must have had a name within the Content-Disposition header.

Author:

Niall Gallagher

Method Summary

boolean	addPart(Part part) This is used to add a part to the list.
Part	getPart(String name) This method is used to acquire a Part from the list using a known name for the part.
List<Part>	getParts() This is used to acquire the attachments associated with this list.

Method Detail

getParts

List<Part> getParts()

This is used to acquire the attachments associated with this list. If no parts have been collected by this list then it will return an empty list. The order of the parts in the list are the insertion order for consistency.

Returns:

this returns the parts collected in iteration order

addPart

boolean addPart(Part part)

This is used to add a part to the list. The order the parts are added to the list is the iteration order. If the part has a name that is not null then it is added to an internal map using that name. This allows it to be accesses by name at a later time.

Parameters:

part - this is the part that is to be added to the list

Returns:

returns true if the list has changed due to the add

getPart

Part getPart(String name)

This method is used to acquire a Part from the list using a known name for the part. This is a convenient way to access a part when the name for the part is known.

Parameters:

name - this is the name of the part to acquire

Returns:

the named part or null if the part does not exist