Tomcat 10.1.19 · jakarta.servlet.http.Part · APIdia, the JavaDoc alternative

Method Summary

Modifier and Type	Method and Description
public void	delete() Deletes the underlying storage for a part, including deleting any associated temporary disk file.
public String	Returns: The content type passed by the browser or `null` if not defined. getContentType() Obtain the content type passed by the browser.
public String	Returns: The header value or `null` if the header is not present getHeader(String Header name name) Obtains the value of the specified part header as a String.
public Collection<String>	Returns: a Collection of all the header names provided for this part. getHeaderNames() Get the header names provided for this part.
public Collection<String>	Returns: All the values of the specified part header. If the part did not include any headers of the specified name, this method returns an empty Collection. getHeaders(String The name of the header of interest. The header name is case insensitive. name) Obtain all the values of the specified part header.
public InputStream	Returns: An InputStream for the contents of the file getInputStream() Obtain an `InputStream` that can be used to retrieve the contents of the file.
public String	Returns: The name of the field in the multipart form corresponding to this part. getName() Obtain the name of the field in the multipart form corresponding to this part.
public long	Returns: The size of the part if bytes getSize() Obtain the size of this part.
public String	Returns: the submitted file name or `null`. getSubmittedFileName() If this part represents an uploaded file, gets the file name submitted in the upload.
public void	write(String The location into which the uploaded part should be stored. Relative locations are relative to `jakarta.servlet.MultipartConfigElement#getLocation()` fileName) A convenience method to write an uploaded part to disk.

Method Detail

delete	back to summary
public void delete() throws IOException Deletes the underlying storage for a part, including deleting any associated temporary disk file. Although the container will delete this storage automatically this method can be used to ensure that this is done at an earlier time, thus preserving system resources. Containers are only required to delete the associated storage when the Part instance is garbage collected. Apache Tomcat will delete the associated storage when the associated request has finished processing. Behaviour of other containers may be different. Exceptions IOException: if an I/O occurs while attempting to delete the part

delete

back to summary

public void delete() throws IOException

Deletes the underlying storage for a part, including deleting any associated temporary disk file. Although the container will delete this storage automatically this method can be used to ensure that this is done at an earlier time, thus preserving system resources.

Containers are only required to delete the associated storage when the Part instance is garbage collected. Apache Tomcat will delete the associated storage when the associated request has finished processing. Behaviour of other containers may be different.

Exceptions

IOException:: if an I/O occurs while attempting to delete the part

getContentType back to summary

getContentType	back to summary
public String getContentType() Obtain the content type passed by the browser. Returns:String The content type passed by the browser or `null` if not defined.

public String getContentType()

Obtain the content type passed by the browser.

Returns:String: The content type passed by the browser or null if not defined.

getHeader back to summary

getHeader	back to summary
public String getHeader(String name) Obtains the value of the specified part header as a String. If there are multiple headers with the same name, this method returns the first header in the part. The header name is case insensitive. Parameters name:String Header name Returns:String The header value or `null` if the header is not present

public String getHeader(String name)

Obtains the value of the specified part header as a String. If there are multiple headers with the same name, this method returns the first header in the part. The header name is case insensitive.

Parameters

name:String: Header name

Returns:String

The header value or null if the header is not present

getHeaderNames	back to summary
public Collection<String> getHeaderNames() Get the header names provided for this part. Returns:Collection<String> a Collection of all the header names provided for this part.

getHeaderNames

back to summary

public Collection<String> getHeaderNames()

Get the header names provided for this part.

Returns:Collection<String>: a Collection of all the header names provided for this part.

getHeaders	back to summary
public Collection<String> getHeaders(String name) Obtain all the values of the specified part header. Parameters name:String The name of the header of interest. The header name is case insensitive. Returns:Collection<String> All the values of the specified part header. If the part did not include any headers of the specified name, this method returns an empty Collection.

getHeaders

back to summary

public Collection<String> getHeaders(String name)

Obtain all the values of the specified part header.

Parameters

name:String: The name of the header of interest. The header name is case insensitive.

Returns:Collection<String>

All the values of the specified part header. If the part did not include any headers of the specified name, this method returns an empty Collection.

getInputStream back to summary

getInputStream	back to summary
public InputStream getInputStream() throws IOException Obtain an `InputStream` that can be used to retrieve the contents of the file. Returns:InputStream An InputStream for the contents of the file Exceptions IOException: if an I/O occurs while obtaining the stream

public InputStream getInputStream() throws IOException

Obtain an InputStream that can be used to retrieve the contents of the file.

Returns:InputStream

An InputStream for the contents of the file

Exceptions

IOException:: if an I/O occurs while obtaining the stream

getName	back to summary
public String getName() Obtain the name of the field in the multipart form corresponding to this part. Returns:String The name of the field in the multipart form corresponding to this part.

getName

back to summary

public String getName()

Obtain the name of the field in the multipart form corresponding to this part.

Returns:String: The name of the field in the multipart form corresponding to this part.

getSize	back to summary
public long getSize() Obtain the size of this part. Returns:long The size of the part if bytes

getSize

back to summary

public long getSize()

Obtain the size of this part.

Returns:long: The size of the part if bytes

getSubmittedFileName back to summary

getSubmittedFileName	back to summary
public String getSubmittedFileName() If this part represents an uploaded file, gets the file name submitted in the upload. Returns `null` if no file name is available or if this part is not a file upload. Returns:String the submitted file name or `null`. Since Servlet 3.1

public String getSubmittedFileName()

If this part represents an uploaded file, gets the file name submitted in the upload. Returns null if no file name is available or if this part is not a file upload.

Returns:String: the submitted file name or null.
Since: Servlet 3.1

write back to summary

write	back to summary
public void write(String fileName) throws IOException A convenience method to write an uploaded part to disk. The client code is not concerned with whether or not the part is stored in memory, or on disk in a temporary location. They just want to write the uploaded part to a file. This method is not guaranteed to succeed if called more than once for the same part. This allows a particular implementation to use, for example, file renaming, where possible, rather than copying all of the underlying data, thus gaining a significant performance benefit. Parameters fileName:String The location into which the uploaded part should be stored. Relative locations are relative to `jakarta.servlet.MultipartConfigElement#getLocation()` Exceptions IOException: if an I/O occurs while attempting to write the part

public void write(String fileName) throws IOException

A convenience method to write an uploaded part to disk. The client code is not concerned with whether or not the part is stored in memory, or on disk in a temporary location. They just want to write the uploaded part to a file. This method is not guaranteed to succeed if called more than once for the same part. This allows a particular implementation to use, for example, file renaming, where possible, rather than copying all of the underlying data, thus gaining a significant performance benefit.

Parameters

fileName:String: The location into which the uploaded part should be stored. Relative locations are relative to jakarta.servlet.MultipartConfigElement#getLocation()

Exceptions

IOException:: if an I/O occurs while attempting to write the part

public Interface Part

Method Summary

Method Detail