twitter4j

Class HttpParameter

java.lang.Object

twitter4j.HttpParameter

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable

public final class HttpParameter
extends java.lang.Object
implements java.lang.Comparable, java.io.Serializable

A data class representing HTTP Post parameter

Author:

Yusuke Yamamoto - yusuke at mac.com

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private java.io.File	file
private java.io.InputStream	fileBody
private static java.lang.String	GIF
private static java.lang.String	JPEG
private java.lang.String	name
private static java.lang.String	OCTET
private static java.lang.String	PNG
private static long	serialVersionUID
private java.lang.String	value

Constructor Summary

Constructors

Constructor and Description
HttpParameter(java.lang.String name, boolean value)
HttpParameter(java.lang.String name, double value)
HttpParameter(java.lang.String name, java.io.File file)
HttpParameter(java.lang.String name, int value)
HttpParameter(java.lang.String name, long value)
HttpParameter(java.lang.String name, java.lang.String value)
HttpParameter(java.lang.String name, java.lang.String fileName, java.io.InputStream fileBody)

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(java.lang.Object o)
static boolean	containsFile(HttpParameter[] params)
(package private) static boolean	containsFile(java.util.List<HttpParameter> params)
static java.lang.String	encode(java.lang.String value)
static java.lang.String	encodeParameters(HttpParameter[] httpParams)
boolean	equals(java.lang.Object o)
java.lang.String	getContentType()
java.io.File	getFile()
java.io.InputStream	getFileBody()
java.lang.String	getName()
static HttpParameter[]	getParameterArray(java.lang.String name, int value)
static HttpParameter[]	getParameterArray(java.lang.String name1, int value1, java.lang.String name2, int value2)
static HttpParameter[]	getParameterArray(java.lang.String name, java.lang.String value)
static HttpParameter[]	getParameterArray(java.lang.String name1, java.lang.String value1, java.lang.String name2, java.lang.String value2)
java.lang.String	getValue()
boolean	hasFileBody()
int	hashCode()
boolean	isFile()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

name

private java.lang.String name

value

private java.lang.String value

file

private java.io.File file

fileBody

private java.io.InputStream fileBody

JPEG

private static final java.lang.String JPEG

See Also:

Constant Field Values

GIF

private static final java.lang.String GIF

See Also:

Constant Field Values

PNG

private static final java.lang.String PNG

See Also:

Constant Field Values

OCTET

private static final java.lang.String OCTET

See Also:

Constant Field Values

Constructor Detail

HttpParameter

public HttpParameter(java.lang.String name,
             java.lang.String value)

HttpParameter

public HttpParameter(java.lang.String name,
             java.io.File file)

HttpParameter

public HttpParameter(java.lang.String name,
             java.lang.String fileName,
             java.io.InputStream fileBody)

HttpParameter

public HttpParameter(java.lang.String name,
             int value)

HttpParameter

public HttpParameter(java.lang.String name,
             long value)

HttpParameter

public HttpParameter(java.lang.String name,
             double value)

HttpParameter

public HttpParameter(java.lang.String name,
             boolean value)

Method Detail

getName

public java.lang.String getName()

getValue

public java.lang.String getValue()

getFile

public java.io.File getFile()

getFileBody

public java.io.InputStream getFileBody()

isFile

public boolean isFile()

hasFileBody

public boolean hasFileBody()

getContentType

public java.lang.String getContentType()

Returns:

content-type

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

containsFile

public static boolean containsFile(HttpParameter[] params)

containsFile

static boolean containsFile(java.util.List<HttpParameter> params)

getParameterArray

public static HttpParameter[] getParameterArray(java.lang.String name,
                                java.lang.String value)

getParameterArray

public static HttpParameter[] getParameterArray(java.lang.String name,
                                int value)

getParameterArray

public static HttpParameter[] getParameterArray(java.lang.String name1,
                                java.lang.String value1,
                                java.lang.String name2,
                                java.lang.String value2)

getParameterArray

public static HttpParameter[] getParameterArray(java.lang.String name1,
                                int value1,
                                java.lang.String name2,
                                int value2)

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

compareTo

public int compareTo(java.lang.Object o)

Specified by:

compareTo in interface java.lang.Comparable

encodeParameters

public static java.lang.String encodeParameters(HttpParameter[] httpParams)

encode

public static java.lang.String encode(java.lang.String value)

Parameters:

value - string to be encoded

Returns:

encoded string

See Also:

OAuth / TestCases, Space encoding - OAuth | Google Groups, RFC 3986 - Uniform Resource Identifier (URI): Generic Syntax - 2.1. Percent-Encoding