Package org.simpleframework.http.message
Class BufferPart
- java.lang.Object
-
- org.simpleframework.http.message.BufferPart
-
- All Implemented Interfaces:
Part
class BufferPart extends java.lang.Object implements Part
TheBufferPartis used to represent a part within a request message. Typically a part represents either a text parameter or a file, with associated headers. The contents of the part can be acquire as anInputStreamor as a string encoded in the default HTTP encoding ISO-8859-1 or in the encoding specified with the Content-Type header.
-
-
Constructor Summary
Constructors Constructor Description BufferPart(Segment segment, Buffer buffer)Constructor for theBufferPartobject.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.StringgetContent()This is used to acquire the content of the part as a string.ContentTypegetContentType()This is used to acquire the content type for this part.ContentDispositiongetDisposition()This is used to acquire the content disposition for the part.java.lang.StringgetFileName()This method is used to acquire the file name of the part.java.lang.StringgetHeader(java.lang.String name)This is used to acquire the header value for the specified header name.java.io.InputStreamgetInputStream()This is used to acquire anInputStreamfor the part.java.lang.StringgetName()This method is used to acquire the name of the part.booleanisFile()This method is used to determine the type of a part.
-
-
-
Constructor Detail
-
BufferPart
public BufferPart(Segment segment, Buffer buffer)
Constructor for theBufferPartobject. This is used to create a part from a multipart body. Each part will contain the headers associated with it as well as the body.- Parameters:
segment- this holds the headers for the partbuffer- this represents the body for the part
-
-
Method Detail
-
isFile
public boolean isFile()
This method is used to determine the type of a part. Typically a part is either a text parameter or a file. If this is true then the content represented by the associated part is a file.
-
getName
public java.lang.String getName()
This method is used to acquire the name of the part. Typically this is used when the part represents a text parameter rather than a file. However, this can also be used with a file part.
-
getFileName
public java.lang.String getFileName()
This method is used to acquire the file name of the part. This is used when the part represents a text parameter rather than a file. However, this can also be used with a file part.- Specified by:
getFileNamein interfacePart- Returns:
- this returns the file name of the associated part
-
getContent
public java.lang.String getContent() throws java.io.IOExceptionThis is used to acquire the content of the part as a string. The encoding of the string is taken from the content type. If no content type is sent the content is decoded in the standard default of ISO-8859-1.- Specified by:
getContentin interfacePart- Returns:
- this returns a string representing the content
- Throws:
java.io.IOException- thrown if the content can not be created
-
getInputStream
public java.io.InputStream getInputStream() throws java.io.IOExceptionThis is used to acquire anInputStreamfor the part. Acquiring the stream allows the content of the part to be consumed by reading the stream. Each invocation of this method will produce a new stream starting from the first byte.- Specified by:
getInputStreamin interfacePart- Returns:
- this returns the stream for this part object
- Throws:
java.io.IOException- thrown if the stream can not be created
-
getContentType
public ContentType getContentType()
This is used to acquire the content type for this part. This is typically the type of content for a file part, as provided by a MIME type from the HTTP "Content-Type" header.- Specified by:
getContentTypein interfacePart- Returns:
- this returns the content type for the part object
-
getDisposition
public ContentDisposition getDisposition()
This is used to acquire the content disposition for the part. The content disposition contains the Content-Disposition header details sent with the part in the multipart request body.- Returns:
- value of the header mapped to the specified name
-
getHeader
public java.lang.String getHeader(java.lang.String name)
This is used to acquire the header value for the specified header name. Providing the header values through this method ensures any special processing for a know content type can be handled by an application.
-
-