如何为RxJava中抛出异常的可观察返回编写文档
不确定如何以Java文档样式记录抛出声明。以下示例:如何为RxJava中抛出异常的可观察返回编写文档,java,styles,rx-java,javadoc,Java,Styles,Rx Java,Javadoc,不确定如何以Java文档样式记录抛出声明。以下示例: /** * Get Facebook Friends * * @param facebookToken - Facebook Token * @return list of {@link User} * @throws SomeCheckedException <- this is normally the way, but not for Observable return type */ public Observab
/**
* Get Facebook Friends
*
* @param facebookToken - Facebook Token
* @return list of {@link User}
* @throws SomeCheckedException <- this is normally the way, but not for Observable return type
*/
public Observable<List<User>> getFriends(String facebookToken) {
return get("/me/friends", facebookToken)
.flatMap(response -> {
FacebookResponse facebookResponse = response.readEntity(FacebookResponse.class);
if (null != facebookResponse.getError()) {
return Observable.error(parseException(facebookResponse.getError()));
} else if (null == facebookResponse.getData()) {
return Observable.error(new FacebookException("Empty data"));
}
return Observable.just(facebookResponse.getData());
});
}
/**
*获得Facebook好友
*
*@param facebookToken-Facebook Token
*@返回{@link User}的列表
*@抛出了一些checkedException{
FacebookResponse FacebookResponse=response.readEntity(FacebookResponse.class);
if(null!=facebookResponse.getError()){
返回Observable.error(parseException(facebookResponse.getError());
}else if(null==facebookResponse.getData()){
返回可观察到的错误(新的FacebookException(“空数据”));
}
返回Observable.just(facebookResponse.getData());
});
}
该方法应该返回Observable.error()
,我想让调用该方法的开发人员知道,在onErrorNextResume
中可能会处理异常,等等
不要涵盖任何类似的内容。您是对的,此方法不会引发任何错误,但它可能会返回发出错误的
可观察的。在我目前工作的公司,我们高度使用反应式编程,对于这些情况,我们删除@throw
行,并将此信息添加到@return
:
@return an {@link Observable} containing the retrieved {@link User}s; yields a {@link FacebookException} in case of empty data.
您是对的,此方法不会抛出任何错误,但它可能会返回一个发出错误的可观察的。在我目前工作的公司,我们高度使用反应式编程,对于这些情况,我们删除@throw
行,并将此信息添加到@return
:
@return an {@link Observable} containing the retrieved {@link User}s; yields a {@link FacebookException} in case of empty data.