程序包 com.dtflys.forest

类 Forest

java.lang.Object

com.dtflys.forest.Forest

public abstract class Forest
extends Object

Forest 快捷接口

该类提供 Forest 常用的基本接口方法, 列如:

     // 获取 Forest GET请求
     Forest.get("http://localhost:8080")

     // 获取 Forest POST请求
     Forest.post("http://localhost:8080")

     // 创建或获取全局默认配置，即 ForestConfiguration 对象
     Forest.config();
 

从以下版本开始:

1.5.2

作者:

gongjun [dt_flys@hotmail.com]

字段概要

字段

修饰符和类型	字段	说明
static final String	VERSION	当前 Forest 版本号

构造器概要

构造器

构造器	说明
Forest()

方法概要

修饰符和类型	方法	说明
static List<ForestResponse>	await(ForestFuture... futures)	等待多个请求响应结果，并阻塞当前调用改方法的线程，只有当参数中所有请求结果都返回后才会继续执行
static List<ForestResponse>	await(Collection<ForestFuture> futures)	等待多个请求响应结果，并阻塞当前调用改方法的线程，只有当参数中所有请求结果都返回后才会继续执行
static void	await(Collection<ForestFuture> futures, Consumer<ForestResponse> callback)	等待多个请求响应结果，并阻塞当前调用改方法的线程，当参数中所有请求结果都返回后调用参数中的 callback 回调函数
static <T> T	client(Class<T> clazz)	创建 Forest 客户端接口实例
static ForestConfiguration	config()	获取或创建全局默认配置，即 ForestConfiguration 对象
static ForestConfiguration	config(String id)	根据配置ID获取或创建配置，即 ForestConfiguration 对象
static ForestRequest<?>	delete(String url)	创建 DELETE 请求的 ForestRequest 对象
static ForestRequest<?>	get(String url)	创建 GET 请求的 ForestRequest 对象
static ForestRequest<?>	head(String url)	创建 HEAD 请求的 ForestRequest 对象
static ForestRequest<?>	options(String url)	创建 OPTIONS 请求的 ForestRequest 对象
static ForestRequest<?>	patch(String url)	创建 PATCH 请求的 ForestRequest 对象
static ForestRequest<?>	post(String url)	创建 POST 请求的 ForestRequest 对象
static ForestRequest<?>	put(String url)	创建 PUT 请求的 ForestRequest 对象
static ForestRequest<?>	request()	创建通用 ForestRequest 对象
static <R> ForestRequest<R>	request(Class<R> clazz)	创建通用 ForestRequest 对象
static ForestRequest<?>	trace(String url)	创建 TRACE 请求的 ForestRequest 对象

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

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

字段详细资料

VERSION

public static final String VERSION

当前 Forest 版本号

构造器详细资料

Forest

public Forest()

方法详细资料

config

public static ForestConfiguration config()

获取或创建全局默认配置，即 ForestConfiguration 对象

全局默认配置的配置ID为 forestConfiguration

返回:

ForestConfiguration 对象

config

public static ForestConfiguration config(String id)

根据配置ID获取或创建配置，即 ForestConfiguration 对象

参数:

id - 配置 ID

返回:

ForestConfiguration 对象

client

public static <T> T client(Class<T> clazz)

创建 Forest 客户端接口实例

类型参数:

T - 请求接口类泛型

参数:

clazz - 请求接口类

返回:

Forest 接口实例

request

public static ForestRequest<?> request()

创建通用 ForestRequest 对象

返回:

ForestRequest 对象

request

public static <R> ForestRequest<R> request(Class<R> clazz)

创建通用 ForestRequest 对象

类型参数:

R - 返回结果类型泛型参数

参数:

clazz - 返回结果类型

返回:

ForestRequest 对象

get

public static ForestRequest<?> get(String url)

创建 GET 请求的 ForestRequest 对象

参数:

url - 请求 URL

返回:

ForestRequest 对象

另请参阅:

• ForestConfiguration.get(String)

post

public static ForestRequest<?> post(String url)

创建 POST 请求的 ForestRequest 对象

参数:

url - 请求 URL

返回:

ForestRequest 对象

另请参阅:

• ForestConfiguration.get(String)

put

public static ForestRequest<?> put(String url)

创建 PUT 请求的 ForestRequest 对象

参数:

url - 请求 URL

返回:

ForestRequest 对象

另请参阅:

• ForestConfiguration.get(String)

delete

public static ForestRequest<?> delete(String url)

创建 DELETE 请求的 ForestRequest 对象

参数:

url - 请求 URL

返回:

ForestRequest 对象

另请参阅:

• ForestConfiguration.get(String)

head

public static ForestRequest<?> head(String url)

创建 HEAD 请求的 ForestRequest 对象

参数:

url - 请求 URL

返回:

ForestRequest 对象

另请参阅:

• ForestConfiguration.get(String)

patch

public static ForestRequest<?> patch(String url)

创建 PATCH 请求的 ForestRequest 对象

参数:

url - 请求 URL

返回:

ForestRequest 对象

另请参阅:

• ForestConfiguration.get(String)

options

public static ForestRequest<?> options(String url)

创建 OPTIONS 请求的 ForestRequest 对象

参数:

url - 请求 URL

返回:

ForestRequest 对象

另请参阅:

• ForestConfiguration.get(String)

trace

public static ForestRequest<?> trace(String url)

创建 TRACE 请求的 ForestRequest 对象

参数:

url - 请求 URL

返回:

ForestRequest 对象

另请参阅:

• ForestConfiguration.get(String)

await

public static List<ForestResponse> await(ForestFuture... futures)

等待多个请求响应结果，并阻塞当前调用改方法的线程，只有当参数中所有请求结果都返回后才会继续执行

参数:

futures - 可变参数 - 多个请求的 ForestFuture 对象

返回:

请求返回后的 Forest 响应对象列表

从以下版本开始:

1.5.27

await

public static List<ForestResponse> await(Collection<ForestFuture> futures)

等待多个请求响应结果，并阻塞当前调用改方法的线程，只有当参数中所有请求结果都返回后才会继续执行

参数:

futures - 多个请求的 ForestFuture 对象集合

返回:

请求返回后的 Forest 响应对象列表

从以下版本开始:

1.5.27

await

public static void await(Collection<ForestFuture> futures,
 Consumer<ForestResponse> callback)

等待多个请求响应结果，并阻塞当前调用改方法的线程，当参数中所有请求结果都返回后调用参数中的 callback 回调函数

参数:

futures - 多个请求的 ForestFuture 对象集合

callback - 回调函数，只有当参数中所有请求的响应都返回后才会被调用

从以下版本开始:

1.5.27