Overview Package Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

org.apache.commons.httpclient.methods.multipart

Class StringPart

public class StringPart
extends PartBase
Simple string parameter for a multipart post
Authors:
Matthew Albright
Jeff Dever
Mike Bowler
Oleg Kalnichevski
Since:
2.0

Field Summary

static String
DEFAULT_CHARSET
Default charset of string parameters
static String
DEFAULT_CONTENT_TYPE
Default content encoding of string parameters.
static String
DEFAULT_TRANSFER_ENCODING
Default transfer encoding of string parameters

Fields inherited from class org.apache.commons.httpclient.methods.multipart.Part

BOUNDARY, BOUNDARY_BYTES, CHARSET, CHARSET_BYTES, CONTENT_DISPOSITION, CONTENT_DISPOSITION_BYTES, CONTENT_TRANSFER_ENCODING, CONTENT_TRANSFER_ENCODING_BYTES, CONTENT_TYPE, CONTENT_TYPE_BYTES, CRLF, CRLF_BYTES, EXTRA, EXTRA_BYTES, QUOTE, QUOTE_BYTES

Constructor Summary

StringPart(String name, String value)
Constructor.
StringPart(String name, String value, String charset)
Constructor.

Method Summary

protected long
lengthOfData()
Return the length of the data.
protected void
sendData(OutputStream out)
Writes the data to the given OutputStream.
void
setCharSet(String charSet)
Sets the character encoding.

Methods inherited from class org.apache.commons.httpclient.methods.multipart.PartBase

getCharSet, getContentType, getName, getTransferEncoding, setCharSet, setContentType, setName, setTransferEncoding

Methods inherited from class org.apache.commons.httpclient.methods.multipart.Part

getBoundary, getCharSet, getContentType, getLengthOfParts, getLengthOfParts, getName, getPartBoundary, getTransferEncoding, isRepeatable, length, lengthOfData, send, sendContentTypeHeader, sendData, sendDispositionHeader, sendEnd, sendEndOfHeader, sendParts, sendParts, sendStart, sendTransferEncodingHeader, toString

Field Details

DEFAULT_CHARSET

public static final String DEFAULT_CHARSET
Default charset of string parameters

DEFAULT_CONTENT_TYPE

public static final String DEFAULT_CONTENT_TYPE
Default content encoding of string parameters.

DEFAULT_TRANSFER_ENCODING

public static final String DEFAULT_TRANSFER_ENCODING
Default transfer encoding of string parameters

Constructor Details

StringPart

public StringPart(String name,
                  String value)
Constructor.
Parameters:
name - The name of the part
value - the string to post

StringPart

public StringPart(String name,
                  String value,
                  String charset)
Constructor.
Parameters:
name - The name of the part
value - the string to post
charset - the charset to be used to encode the string, if null the default is used

Method Details

lengthOfData

protected long lengthOfData()
            throws IOException
Return the length of the data.
Overrides:
lengthOfData in interface Part
Returns:
The length of the data.
See Also:
Part.lengthOfData()

sendData

protected void sendData(OutputStream out)
            throws IOException
Writes the data to the given OutputStream.
Overrides:
sendData in interface Part
Parameters:
out - the OutputStream to write to

setCharSet

public void setCharSet(String charSet)
Sets the character encoding.
Overrides:
setCharSet in interface PartBase
Parameters:
charSet - the character encoding, or null to exclude the character encoding header

Overview Package Tree Index Deprecated About
Copyright (c) 1999-2005 - Apache Software Foundation