com.loopj.android.http

类 RequestParams

java.lang.Object

com.loopj.android.http.RequestParams

所有已实现的接口:

java.io.Serializable

public class RequestParams
extends java.lang.Object
implements java.io.Serializable

A collection of string request parameters or files to send along with requests made from an AsyncHttpClient instance.

For example:

 RequestParams params = new RequestParams();
 params.put("username", "james");
 params.put("password", "123456");
 params.put("email", "my@email.com");
 params.put("profile_picture", new File("pic.jpg")); // Upload a File
 params.put("profile_picture2", someInputStream); // Upload an InputStream
 params.put("profile_picture3", new ByteArrayInputStream(someBytes)); // Upload some bytes

 Map<String, String> map = new HashMap<String, String>();
 map.put("first_name", "James");
 map.put("last_name", "Smith");
 params.put("user", map); // url params: "user[first_name]=James&user[last_name]=Smith"

 Set<String> set = new HashSet<String>(); // unordered collection
 set.add("music");
 set.add("art");
 params.put("like", set); // url params: "like=music&like=art"

 List<String> list = new ArrayList<String>(); // Ordered collection
 list.add("Java");
 list.add("C");
 params.put("languages", list); // url params: "languages[]=Java&languages[]=C"

 String[] colors = { "blue", "yellow" }; // Ordered collection
 params.put("colors", colors); // url params: "colors[]=blue&colors[]=yellow"

 List<Map<String, String>> listOfMaps = new ArrayList<Map<String,
 String>>();
 Map<String, String> user1 = new HashMap<String, String>();
 user1.put("age", "30");
 user1.put("gender", "male");
 Map<String, String> user2 = new HashMap<String, String>();
 user2.put("age", "25");
 user2.put("gender", "female");
 listOfMaps.add(user1);
 listOfMaps.add(user2);
 params.put("users", listOfMaps); // url params: "users[][age]=30&users[][gender]=male&users[][age]=25&users[][gender]=female"

 AsyncHttpClient client = new AsyncHttpClient();
 client.post("http://myendpoint.com", params, responseHandler);
 

另请参阅:

序列化表格

嵌套类概要

嵌套类

限定符和类型	类和说明
static class	RequestParams.FileWrapper
static class	RequestParams.StreamWrapper

字段概要

字段

限定符和类型	字段和说明
static java.lang.String	APPLICATION_JSON
static java.lang.String	APPLICATION_OCTET_STREAM
protected boolean	autoCloseInputStreams
protected java.lang.String	contentEncoding
protected java.lang.String	elapsedFieldInJsonStreamer
protected java.util.concurrent.ConcurrentHashMap<java.lang.String,RequestParams.FileWrapper>	fileParams
protected boolean	isRepeatable
protected static java.lang.String	LOG_TAG
protected java.util.concurrent.ConcurrentHashMap<java.lang.String,RequestParams.StreamWrapper>	streamParams
protected java.util.concurrent.ConcurrentHashMap<java.lang.String,java.lang.String>	urlParams
protected java.util.concurrent.ConcurrentHashMap<java.lang.String,java.lang.Object>	urlParamsWithObjects
protected boolean	useJsonStreamer

构造器概要

构造器

构造器和说明
RequestParams() Constructs a new empty RequestParams instance.
RequestParams(java.util.Map<java.lang.String,java.lang.String> source) Constructs a new RequestParams instance containing the key/value string params from the specified map.
RequestParams(java.lang.Object... keysAndValues) Constructs a new RequestParams instance and populate it with multiple initial key/value string param.
RequestParams(java.lang.String key, java.lang.String value) Constructs a new RequestParams instance and populate it with a single initial key/value string param.

方法概要

限定符和类型	方法和说明
void	add(java.lang.String key, java.lang.String value) Adds string value to param which can have more than one value.
HttpEntity	getEntity(ResponseHandlerInterface progressHandler) Returns an HttpEntity containing all request parameters.
protected java.util.List<BasicNameValuePair>	getParamsList()
protected java.lang.String	getParamString()
boolean	has(java.lang.String key) Check if a parameter is defined.
void	put(java.lang.String key, java.io.File file) Adds a file to the request.
void	put(java.lang.String key, java.io.File file, java.lang.String contentType) Adds a file to the request with custom provided file content-type
void	put(java.lang.String key, java.io.File file, java.lang.String contentType, java.lang.String customFileName) Adds a file to the request with both custom provided file content-type and file name
void	put(java.lang.String key, java.io.InputStream stream) Adds an input stream to the request.
void	put(java.lang.String key, java.io.InputStream stream, java.lang.String name) Adds an input stream to the request.
void	put(java.lang.String key, java.io.InputStream stream, java.lang.String name, java.lang.String contentType) Adds an input stream to the request.
void	put(java.lang.String key, java.io.InputStream stream, java.lang.String name, java.lang.String contentType, boolean autoClose) Adds an input stream to the request.
void	put(java.lang.String key, int value) Adds a int value to the request.
void	put(java.lang.String key, long value) Adds a long value to the request.
void	put(java.lang.String key, java.lang.Object value) Adds param with non-string value (e.g.
void	put(java.lang.String key, java.lang.String value) Adds a key/value string pair to the request.
void	put(java.lang.String key, java.lang.String customFileName, java.io.File file) Adds a file to the request with custom provided file name
void	remove(java.lang.String key) Removes a parameter from the request.
void	setAutoCloseInputStreams(boolean flag) Set global flag which determines whether to automatically close input streams on successful upload.
void	setContentEncoding(java.lang.String encoding) Sets content encoding for return value of getParamString() and createFormEntity() Default encoding is "UTF-8"
void	setElapsedFieldInJsonStreamer(java.lang.String value) Sets an additional field when upload a JSON object through the streamer to hold the time, in milliseconds, it took to upload the payload.
void	setHttpEntityIsRepeatable(boolean flag)
void	setUseJsonStreamer(boolean flag)
java.lang.String	toString()

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

字段详细资料

APPLICATION_OCTET_STREAM

public static final java.lang.String APPLICATION_OCTET_STREAM

另请参阅:

常量字段值

APPLICATION_JSON

public static final java.lang.String APPLICATION_JSON

另请参阅:

常量字段值

LOG_TAG

protected static final java.lang.String LOG_TAG

另请参阅:

常量字段值

isRepeatable

protected boolean isRepeatable

useJsonStreamer

protected boolean useJsonStreamer

elapsedFieldInJsonStreamer

protected java.lang.String elapsedFieldInJsonStreamer

autoCloseInputStreams

protected boolean autoCloseInputStreams

urlParams

protected final java.util.concurrent.ConcurrentHashMap<java.lang.String,java.lang.String> urlParams

streamParams

protected final java.util.concurrent.ConcurrentHashMap<java.lang.String,RequestParams.StreamWrapper> streamParams

fileParams

protected final java.util.concurrent.ConcurrentHashMap<java.lang.String,RequestParams.FileWrapper> fileParams

urlParamsWithObjects

protected final java.util.concurrent.ConcurrentHashMap<java.lang.String,java.lang.Object> urlParamsWithObjects

contentEncoding

protected java.lang.String contentEncoding

构造器详细资料

RequestParams

public RequestParams()

Constructs a new empty RequestParams instance.

RequestParams

public RequestParams(java.util.Map<java.lang.String,java.lang.String> source)

Constructs a new RequestParams instance containing the key/value string params from the specified map.

参数:

source - the source key/value string map to add.

RequestParams

public RequestParams(java.lang.String key,
                     java.lang.String value)

Constructs a new RequestParams instance and populate it with a single initial key/value string param.

参数:

key - the key name for the intial param.

value - the value string for the initial param.

RequestParams

public RequestParams(java.lang.Object... keysAndValues)

Constructs a new RequestParams instance and populate it with multiple initial key/value string param.

参数:

keysAndValues - a sequence of keys and values. Objects are automatically converted to Strings (including the value null).

抛出:

java.lang.IllegalArgumentException - if the number of arguments isn't even.

方法详细资料

setContentEncoding

public void setContentEncoding(java.lang.String encoding)

Sets content encoding for return value of getParamString() and createFormEntity()

Default encoding is "UTF-8"

参数:

encoding - String constant from { HTTP}

put

public void put(java.lang.String key,
                java.lang.String value)

Adds a key/value string pair to the request.

参数:

key - the key name for the new param.

value - the value string for the new param.

put

public void put(java.lang.String key,
                java.io.File file)
         throws java.io.FileNotFoundException

Adds a file to the request.

参数:

key - the key name for the new param.

file - the file to add.

抛出:

java.io.FileNotFoundException - throws if wrong File argument was passed

put

public void put(java.lang.String key,
                java.lang.String customFileName,
                java.io.File file)
         throws java.io.FileNotFoundException

Adds a file to the request with custom provided file name

参数:

key - the key name for the new param.

file - the file to add.

customFileName - file name to use instead of real file name

抛出:

java.io.FileNotFoundException - throws if wrong File argument was passed

put

public void put(java.lang.String key,
                java.io.File file,
                java.lang.String contentType)
         throws java.io.FileNotFoundException

Adds a file to the request with custom provided file content-type

参数:

key - the key name for the new param.

file - the file to add.

contentType - the content type of the file, eg. application/json

抛出:

java.io.FileNotFoundException - throws if wrong File argument was passed

put

public void put(java.lang.String key,
                java.io.File file,
                java.lang.String contentType,
                java.lang.String customFileName)
         throws java.io.FileNotFoundException

Adds a file to the request with both custom provided file content-type and file name

参数:

key - the key name for the new param.

file - the file to add.

contentType - the content type of the file, eg. application/json

customFileName - file name to use instead of real file name

抛出:

java.io.FileNotFoundException - throws if wrong File argument was passed

put

public void put(java.lang.String key,
                java.io.InputStream stream)

Adds an input stream to the request.

参数:

key - the key name for the new param.

stream - the input stream to add.

put

public void put(java.lang.String key,
                java.io.InputStream stream,
                java.lang.String name)

Adds an input stream to the request.

参数:

key - the key name for the new param.

stream - the input stream to add.

name - the name of the stream.

put

public void put(java.lang.String key,
                java.io.InputStream stream,
                java.lang.String name,
                java.lang.String contentType)

Adds an input stream to the request.

参数:

key - the key name for the new param.

stream - the input stream to add.

name - the name of the stream.

contentType - the content type of the file, eg. application/json

put

public void put(java.lang.String key,
                java.io.InputStream stream,
                java.lang.String name,
                java.lang.String contentType,
                boolean autoClose)

Adds an input stream to the request.

参数:

key - the key name for the new param.

stream - the input stream to add.

name - the name of the stream.

contentType - the content type of the file, eg. application/json

autoClose - close input stream automatically on successful upload

put

public void put(java.lang.String key,
                java.lang.Object value)

Adds param with non-string value (e.g. Map, List, Set).

参数:

key - the key name for the new param.

value - the non-string value object for the new param.

put

public void put(java.lang.String key,
                int value)

Adds a int value to the request.

参数:

key - the key name for the new param.

value - the value int for the new param.

put

public void put(java.lang.String key,
                long value)

Adds a long value to the request.

参数:

key - the key name for the new param.

value - the value long for the new param.

add

public void add(java.lang.String key,
                java.lang.String value)

Adds string value to param which can have more than one value.

参数:

key - the key name for the param, either existing or new.

value - the value string for the new param.

remove

public void remove(java.lang.String key)

Removes a parameter from the request.

参数:

key - the key name for the parameter to remove.

has

public boolean has(java.lang.String key)

Check if a parameter is defined.

参数:

key - the key name for the parameter to check existence.

返回:

Boolean

toString

public java.lang.String toString()

覆盖:

toString 在类中 java.lang.Object

setHttpEntityIsRepeatable

public void setHttpEntityIsRepeatable(boolean flag)

setUseJsonStreamer

public void setUseJsonStreamer(boolean flag)

setElapsedFieldInJsonStreamer

public void setElapsedFieldInJsonStreamer(java.lang.String value)

Sets an additional field when upload a JSON object through the streamer to hold the time, in milliseconds, it took to upload the payload. By default, this field is set to "_elapsed". To disable this feature, call this method with null as the field value.

参数:

value - field name to add elapsed time, or null to disable

setAutoCloseInputStreams

public void setAutoCloseInputStreams(boolean flag)

Set global flag which determines whether to automatically close input streams on successful upload.

参数:

flag - boolean whether to automatically close input streams

getEntity

public HttpEntity getEntity(ResponseHandlerInterface progressHandler)
                     throws java.io.IOException

Returns an HttpEntity containing all request parameters.

参数:

progressHandler - HttpResponseHandler for reporting progress on entity submit

返回:

HttpEntity resulting HttpEntity to be included along with { org.apache.http.client.methods.HttpEntityEnclosingRequestBase}

抛出:

java.io.IOException - if one of the streams cannot be read

getParamsList

protected java.util.List<BasicNameValuePair> getParamsList()

getParamString

protected java.lang.String getParamString()