From fe9bf13884b4cc843ceb574e6f75cca05bf45d6a Mon Sep 17 00:00:00 2001 From: delchev Date: Sat, 2 Mar 2019 15:19:54 +0200 Subject: [PATCH] javadoc fixes --- .../dirigible/api/v3/utils/UrlFacade.java | 2 +- .../js/rhino/api/v3/http/HttpClientAsync.java | 39 ++++++++----------- 2 files changed, 18 insertions(+), 23 deletions(-) diff --git a/api/api-facade/api-utils/src/main/java/org/eclipse/dirigible/api/v3/utils/UrlFacade.java b/api/api-facade/api-utils/src/main/java/org/eclipse/dirigible/api/v3/utils/UrlFacade.java index 636e11b27df..445e1aec9e5 100644 --- a/api/api-facade/api-utils/src/main/java/org/eclipse/dirigible/api/v3/utils/UrlFacade.java +++ b/api/api-facade/api-utils/src/main/java/org/eclipse/dirigible/api/v3/utils/UrlFacade.java @@ -1,5 +1,5 @@ /** - * Copyright (c) 2010-2018 SAP and others. + * Copyright (c) 2010-2019 SAP and others. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at diff --git a/modules/engines/engine-javascript-rhino/src/main/java/org/eclipse/dirigible/engine/js/rhino/api/v3/http/HttpClientAsync.java b/modules/engines/engine-javascript-rhino/src/main/java/org/eclipse/dirigible/engine/js/rhino/api/v3/http/HttpClientAsync.java index e02cafabcba..ab85ea8cfeb 100644 --- a/modules/engines/engine-javascript-rhino/src/main/java/org/eclipse/dirigible/engine/js/rhino/api/v3/http/HttpClientAsync.java +++ b/modules/engines/engine-javascript-rhino/src/main/java/org/eclipse/dirigible/engine/js/rhino/api/v3/http/HttpClientAsync.java @@ -86,10 +86,8 @@ public HttpResponseCallback createCallback(String completeCallback, String failC * the URL * @param options * the options - * @return the response as JSON - * @throws IOException - * In case an I/O exception occurs - * @throws InterruptedException + * @param httpResponseCallback + * the callback */ public void getAsync(String url, String options, HttpResponseCallback httpResponseCallback) { requestsCounter ++; @@ -106,10 +104,10 @@ public void getAsync(String url, String options, HttpResponseCallback httpRespon * the URL * @param options * the options - * @return the response as JSON + * @param httpResponseCallback + * the callback * @throws IOException * In case an I/O exception occurs - * @throws InterruptedException */ public void postAsync(String url, String options, HttpResponseCallback httpResponseCallback) throws IOException { requestsCounter ++; @@ -126,10 +124,10 @@ public void postAsync(String url, String options, HttpResponseCallback httpRespo * the URL * @param options * the options - * @return the response as JSON + * @param httpResponseCallback + * the callback * @throws IOException * In case an I/O exception occurs - * @throws InterruptedException */ public void putAsync(String url, String options, HttpResponseCallback httpResponseCallback) throws IOException { requestsCounter ++; @@ -146,10 +144,8 @@ public void putAsync(String url, String options, HttpResponseCallback httpRespon * the URL * @param options * the options - * @return the response as JSON - * @throws IOException - * In case an I/O exception occurs - * @throws InterruptedException + * @param httpResponseCallback + * the callback */ public void deleteAsync(String url, String options, HttpResponseCallback httpResponseCallback) { requestsCounter ++; @@ -166,10 +162,8 @@ public void deleteAsync(String url, String options, HttpResponseCallback httpRes * the URL * @param options * the options - * @return the response as JSON - * @throws IOException - * In case an I/O exception occurs - * @throws InterruptedException + * @param httpResponseCallback + * the callback */ public void headAsync(String url, String options, HttpResponseCallback httpResponseCallback) { requestsCounter ++; @@ -186,10 +180,8 @@ public void headAsync(String url, String options, HttpResponseCallback httpRespo * the URL * @param options * the options - * @return the response as JSON - * @throws IOException - * In case an I/O exception occurs - * @throws InterruptedException + * @param httpResponseCallback + * the callback */ public void traceAsync(String url, String options, HttpResponseCallback httpResponseCallback) { requestsCounter ++; @@ -202,8 +194,8 @@ public void traceAsync(String url, String options, HttpResponseCallback httpResp /** * Execute request asynchronously * - * @throws InterruptedException - * @throws IOException + * @throws InterruptedException in case an concurrency exception occurs + * @throws IOException in case an I/O exception occurs */ public void execute() throws InterruptedException, IOException { countDownLatch = new CountDownLatch(requestsCounter); @@ -234,6 +226,9 @@ private FutureCallback getCallback() { } } + /** + * The callback handler + */ public class HttpResponseCallback { private final FutureCallback callback;