Package com.google.api.client.http
Class UrlEncodedContent
- java.lang.Object
-
- com.google.api.client.http.AbstractHttpContent
-
- com.google.api.client.http.UrlEncodedContent
-
- All Implemented Interfaces:
HttpContent
,StreamingContent
public class UrlEncodedContent extends AbstractHttpContent
Implements support for HTTP form content encoding serialization of typeapplication/x-www-form-urlencoded
as specified in the HTML 4.0 Specification.Sample usage:
static void setContent(HttpRequest request, Object item) { request.setContent(new UrlEncodedContent(item)); }
Implementation is not thread-safe.
- Since:
- 1.0
- Author:
- Yaniv Inbar
-
-
Constructor Summary
Constructors Constructor Description UrlEncodedContent(Object data)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static UrlEncodedContent
getContent(HttpRequest request)
Returns the URL-encoded content of the given HTTP request, or if none return and set as content a new instance ofUrlEncodedContent
(whosegetData()
is an implementation ofMap
).Object
getData()
Returns the key name/value data ornull
for none.UrlEncodedContent
setData(Object data)
Sets the key name/value data.UrlEncodedContent
setMediaType(HttpMediaType mediaType)
Sets the media type to use for the Content-Type header, ornull
if unspecified.void
writeTo(OutputStream out)
Writes the byte content to the given output stream.-
Methods inherited from class com.google.api.client.http.AbstractHttpContent
computeLength, computeLength, getCharset, getLength, getMediaType, getType, retrySupported
-
-
-
-
Constructor Detail
-
UrlEncodedContent
public UrlEncodedContent(Object data)
- Parameters:
data
- key name/value data
-
-
Method Detail
-
writeTo
public void writeTo(OutputStream out) throws IOException
Description copied from interface:StreamingContent
Writes the byte content to the given output stream.Implementations must not close the output stream, and instead should flush the output stream. Some callers may assume that the the output stream has not been closed, and will fail to work if it has been closed.
- Parameters:
out
- output stream- Throws:
IOException
-
setMediaType
public UrlEncodedContent setMediaType(HttpMediaType mediaType)
Description copied from class:AbstractHttpContent
Sets the media type to use for the Content-Type header, ornull
if unspecified.This will also overwrite any previously set parameter of the media type (for example
"charset"
), and therefore might change other properties as well.- Overrides:
setMediaType
in classAbstractHttpContent
-
getData
public final Object getData()
Returns the key name/value data ornull
for none.- Since:
- 1.5
-
setData
public UrlEncodedContent setData(Object data)
Sets the key name/value data.Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.
- Since:
- 1.5
-
getContent
public static UrlEncodedContent getContent(HttpRequest request)
Returns the URL-encoded content of the given HTTP request, or if none return and set as content a new instance ofUrlEncodedContent
(whosegetData()
is an implementation ofMap
).- Parameters:
request
- HTTP request- Returns:
- URL-encoded content
- Throws:
ClassCastException
- if the HTTP request has a content defined that is notUrlEncodedContent
- Since:
- 1.7
-
-