com.helger.web.fileupload

Interface IFileItemHeaders

All Superinterfaces:

Serializable

All Known Implementing Classes:

FileItemHeaders

public interface IFileItemHeaders
extends Serializable

This class provides support for accessing the headers for a file or form item that was received within a multipart/form-data POST request.

Since:

1.3

Author:

Michael C. Macaluso

Method Summary

Modifier and Type	Method and Description
com.helger.commons.collection.impl.ICommonsList<String>	getAllHeaderNames() Returns a List of all the header names.
String	getHeader(String sName) Returns the value of the specified part header as a String.
String	getHeaderContentDisposition()
String	getHeaderContentLength()
String	getHeaderContentType()
Iterator<String>	getHeaderNames() Returns an Iterator of all the header names.
Iterator<String>	getHeaders(String sName) Returns all the values of the specified item header as an Iterator of String objects.

Method Detail

getHeader

@Nullable
String getHeader(@Nonnull
                            String sName)

Returns the value of the specified part header as a String. If the part did not include a header of the specified name, this method return null. If there are multiple headers with the same name, this method returns the first header in the item. The header name is case insensitive.

Parameters:

sName - a String specifying the header name

Returns:

a String containing the value of the requested header, or null if the item does not have a header of that name

getHeaderContentDisposition

@Nullable
String getHeaderContentDisposition()

getHeaderContentType

@Nullable
String getHeaderContentType()

getHeaderContentLength

@Nullable
String getHeaderContentLength()

getHeaders

@Nonnull
Iterator<String> getHeaders(@Nonnull
                                      String sName)

Returns all the values of the specified item header as an Iterator of String objects.

If the item did not include any headers of the specified name, this method returns an empty Iterator. The header name is case insensitive.

Parameters:

sName - a String specifying the header name

Returns:

an Enumeration containing the values of the requested header. If the item does not have any headers of that name, return an empty Iterator

getHeaderNames

@Nonnull
Iterator<String> getHeaderNames()

Returns an Iterator of all the header names.

Returns:

an Enumeration containing the headers. If the item does not have any headers return an empty Iterator

getAllHeaderNames

@Nonnull
 @ReturnsMutableCopy
com.helger.commons.collection.impl.ICommonsList<String> getAllHeaderNames()

Returns a List of all the header names.

Returns:

an List containing the values of the requested header. If the item does not have any headers of that name return an empty Enumeration