|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.sun.jersey.multipart.BodyPart
com.sun.jersey.multipart.FormDataBodyPart
com.sun.jersey.multipart.file.FileDataBodyPart
public class FileDataBodyPart
An extension of FormDataBodyPart
for associating
File
File as a body part entity.
This class may be used to create body parts that a file attachments. Where appropriate the Content-Disposition parameters and Content-Type header will be derived from the file.
Field Summary |
---|
Fields inherited from class com.sun.jersey.multipart.BodyPart |
---|
cd |
Constructor Summary | |
---|---|
FileDataBodyPart()
A no-args constructor which expects its client to set the values individually, the attributes to be set are fileEntity and name; the media type will be predicted from the fileEntity if not set explicitly |
|
FileDataBodyPart(java.lang.String name,
java.io.File fileEntity)
Constructs the body part with the provided name and file, it predicts the MediaType of the file provided. |
|
FileDataBodyPart(java.lang.String name,
java.io.File fileEntity,
javax.ws.rs.core.MediaType mediaType)
Constructs the body part with all the attributes set for its proper function. |
Method Summary | |
---|---|
java.io.File |
getFileEntity()
Get the file for this body part. |
MediaTypePredictor |
getPredictor()
Get the media type predictor. |
protected javax.ws.rs.core.MediaType |
predictMediaType()
Predict the media type of the current fileEntity. |
protected javax.ws.rs.core.MediaType |
predictMediaType(java.io.File file)
Predict the media type of the provided File . |
void |
setEntity(java.lang.Object entity)
This operation is not supported from this implementation. |
void |
setFileEntity(java.io.File fileEntity)
Sets the fileEntity for this FormDataBodyPart . |
void |
setFileEntity(java.io.File fileEntity,
javax.ws.rs.core.MediaType mediaType)
Sets the MediaType and fileEntity for this FormDataBodyPart . |
void |
setPredictor(MediaTypePredictor predictor)
Set the media type predictor. |
void |
setValue(javax.ws.rs.core.MediaType mediaType,
java.lang.Object value)
This operation is not supported from this implementation. |
Methods inherited from class com.sun.jersey.multipart.FormDataBodyPart |
---|
getContentDisposition, getFormDataContentDisposition, getName, getValue, getValueAs, isSimple, setContentDisposition, setFormDataContentDisposition, setName, setValue |
Methods inherited from class com.sun.jersey.multipart.BodyPart |
---|
cleanup, contentDisposition, entity, getEntity, getEntityAs, getHeaders, getMediaType, getParameterizedHeaders, getParent, getProviders, setMediaType, setParent, setProviders, type |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public FileDataBodyPart()
public FileDataBodyPart(java.lang.String name, java.io.File fileEntity)
MediaType
of the file provided. For the known media types client
will not need to set the media type explicitly.
name
- The name of body partfileEntity
- The file that represents the entityMediaTypePredictor.getMediaTypeFromFile(java.io.File)
,
FileDataBodyPart(java.lang.String, java.io.File, javax.ws.rs.core.MediaType)
public FileDataBodyPart(java.lang.String name, java.io.File fileEntity, javax.ws.rs.core.MediaType mediaType) throws java.lang.IllegalArgumentException
name
- The name of body partfileEntity
- The file that represents the entitymediaType
- The MediaType
of the body part
java.lang.IllegalArgumentException
- If the fileEntity is nullMethod Detail |
---|
public java.io.File getFileEntity()
public void setValue(javax.ws.rs.core.MediaType mediaType, java.lang.Object value) throws java.lang.UnsupportedOperationException
setValue
in class FormDataBodyPart
mediaType
- value
-
java.lang.UnsupportedOperationException
- Operation not supported.setFileEntity(java.io.File, javax.ws.rs.core.MediaType)
public void setEntity(java.lang.Object entity) throws java.lang.UnsupportedOperationException
setEntity
in class BodyPart
entity
-
java.lang.UnsupportedOperationException
- Operation not supported.setFileEntity(java.io.File)
public void setFileEntity(java.io.File fileEntity)
FormDataBodyPart
.
fileEntity
- The entity of this FormDataBodyPart
.public void setFileEntity(java.io.File fileEntity, javax.ws.rs.core.MediaType mediaType)
MediaType
and fileEntity for this FormDataBodyPart
.
fileEntity
- The entity of this body partmediaType
- the media type.protected javax.ws.rs.core.MediaType predictMediaType()
MediaType
protected javax.ws.rs.core.MediaType predictMediaType(java.io.File file)
File
.
file
- the file from which the media type is predicted.
MediaType
public MediaTypePredictor getPredictor()
public void setPredictor(MediaTypePredictor predictor)
predictor
- the media type predictor.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |