net.dongliu.requests.body

类 Part<T>

java.lang.Object

net.dongliu.requests.body.Part<T>

所有已实现的接口:

Serializable

public class Part<T>
extends Object
implements Serializable

This class represent one part(field) of http multipart request body.

作者:

Liu Dong

另请参阅:

序列化表格

方法概要

限定符和类型	方法和说明
T	body() The part body
@Nullable Charset	charset() The charset of this part's content.
Part<T>	charset(Charset charset) The charset of this part's content.
@Nullable String	contentType() The content type of the part.
Part<T>	contentType(String contentType) Set content type for this part.
static Part<File>	file(String name, File file) Create a file multi-part field, from file.
static Part<byte[]>	file(String name, String fileName, byte[] bytes) Create a file multi-part field, from byte array data.
static Part<File>	file(String name, String fileName, File file) Create a file multi-part field, from file.
static Part<InputStream>	file(String name, String fileName, InputStream in) 已过时。 Http body may be send multi times(because of redirect or other reasons), use file(String, String, InputStreamSupplier) instead.
static Part<InputStreamSupplier>	file(String name, String fileName, InputStreamSupplier supplier) Create a file multi-part field, from InputStream.
@Nullable String	fileName() The filename of th part. may be null if not exists
T	getBody() 已过时。 use body()
@Nullable Charset	getCharset() 已过时。 use charset()
@Nullable String	getContentType() 已过时。 use contentType()
@Nullable String	getFileName() 已过时。 use fileName()
String	getName() 已过时。 use name()
String	name() The part field name
static Part<String>	param(String name, String value) 已过时。 use text(String, String) instead.
static Part<String>	text(String name, String value) Create a text multi-part field.
void	writeTo(OutputStream out) Write part content to output stream.

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

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

方法详细资料

contentType

public Part<T> contentType(String contentType)

Set content type for this part.

charset

public Part<T> charset(Charset charset)

The charset of this part's content. Each part of MultiPart body can has it's own charset set. Default not set.

参数:

charset - the charset

返回:

self

file

public static Part<File> file(String name,
                              File file)

Create a file multi-part field, from file. This return a part equivalent to <input type="file" /> field in multi part form.

file

public static Part<File> file(String name,
                              String fileName,
                              File file)

Create a file multi-part field, from file. This return a part equivalent to <input type="file" /> field in multi part form.

file

@Deprecated
public static Part<InputStream> file(String name,
                                                 String fileName,
                                                 InputStream in)

已过时。 Http body may be send multi times(because of redirect or other reasons), use file(String, String, InputStreamSupplier) instead.

Create a file multi-part field, from InputStream. This return a part equivalent to <input type="file" /> field in multi part form.

file

public static Part<InputStreamSupplier> file(String name,
                                             String fileName,
                                             InputStreamSupplier supplier)

Create a file multi-part field, from InputStream. This return a part equivalent to <input type="file" /> field in multi part form.

file

public static Part<byte[]> file(String name,
                                String fileName,
                                byte[] bytes)

Create a file multi-part field, from byte array data. This return a part equivalent to <input type="file" /> field in multi part form.

text

public static Part<String> text(String name,
                                String value)

Create a text multi-part field. This return a part equivalent to <input type="text" /> field in multi part form.

param

@Deprecated
public static Part<String> param(String name,
                                             String value)

已过时。 use text(String, String) instead.

Create a (name, value) text multi-part field. This return a part equivalent to <input type="text" /> field in multi part form.

getName

@Deprecated
public String getName()

已过时。 use name()

getFileName

@Deprecated
public @Nullable String getFileName()

已过时。 use fileName()

getBody

@Deprecated
public T getBody()

已过时。 use body()

getContentType

@Deprecated
public @Nullable String getContentType()

已过时。 use contentType()

getCharset

@Deprecated
public @Nullable Charset getCharset()

已过时。 use charset()

name

public String name()

The part field name

返回:

the name

fileName

public @Nullable String fileName()

The filename of th part. may be null if not exists

body

public T body()

The part body

contentType

public @Nullable String contentType()

The content type of the part. For text part, the contentType is always null.

charset

public @Nullable Charset charset()

The charset of this part's content. Each part of MultiPart body can has it's own charset set. For text part, the charset is always null.

返回:

the charset of this part content. if not set, return null.

writeTo

public void writeTo(OutputStream out)
             throws IOException

Write part content to output stream.

抛出:

IOException