Skip to content

Commit 2fe59c1

Browse files
committed
Javadoc Updates
Signed-off-by: Andy McCright <[email protected]>
1 parent 0547862 commit 2fe59c1

File tree

2 files changed

+20
-12
lines changed

2 files changed

+20
-12
lines changed

tck/src/main/java/org/eclipse/microprofile/rest/client/tck/RestClientBuilderListenerTest.java

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,7 @@
1818

1919
import static org.testng.Assert.assertEquals;
2020

21-
//import java.net.URI;
22-
import java.net.URL;
21+
import java.net.URI;
2322

2423
import org.eclipse.microprofile.rest.client.RestClientBuilder;
2524
import org.eclipse.microprofile.rest.client.spi.RestClientBuilderListener;
@@ -58,15 +57,14 @@ public static WebArchive createDeployment() {
5857
* with a 500 status code, but at priority 2. If the RestClientBuilderListener impl
5958
* is correctly invoked, then the request will abort with the 200; if not,
6059
* it will abort with the 500.
60+
*
61+
* @throws Exception - indicates test failure
6162
*/
6263
@Test
6364
public void testRegistrarInvoked() throws Exception {
6465
SimpleGetApi client = RestClientBuilder.newBuilder()
6566
.register(ReturnWith500RequestFilter.class, 2)
66-
// TODO: rebase after baseUri change goes in and use this line:
67-
//.baseUri(new URI("http://localhost:8080/neverUsed"))
68-
// instead of
69-
.baseUrl(new URL("http://localhost:8080/neverUsed"))
67+
.baseUri(new URI("http://localhost:8080/neverUsed"))
7068
.build(SimpleGetApi.class);
7169

7270
assertEquals(200, client.executeGet().getStatus(),

tck/src/main/java/org/eclipse/microprofile/rest/client/tck/asynctests/AsyncMethodTest.java

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -68,9 +68,11 @@ public static WebArchive createDeployment() {
6868
}
6969

7070
/**
71-
* Tests that a Rest Client interface method that returns Future<Response>
71+
* Tests that a Rest Client interface method that returns CompletionStage
7272
* is invoked asychronously - checking that the thread ID of the response
7373
* does not match the thread ID of the calling thread.
74+
*
75+
* @throws Exception - indicates test failure
7476
*/
7577
@Test
7678
public void testInterfaceMethodWithCompletionStageResponseReturnIsInvokedAsynchronously() throws Exception{
@@ -101,10 +103,12 @@ public void testInterfaceMethodWithCompletionStageResponseReturnIsInvokedAsynchr
101103
}
102104

103105
/**
104-
* Tests that a Rest Client interface method that returns Future<X> (where X
105-
* is some Object type other than Response) is invoked asychronously -
106-
* checking that the thread ID of the response does not match the thread ID
107-
* of the calling thread.
106+
* Tests that a Rest Client interface method that returns a CompletionStage
107+
* where it's parameterized type is some Object type other than Response) is
108+
* invoked asychronously - checking that the thread ID of the response does
109+
* not match the thread ID of the calling thread.
110+
*
111+
* @throws Exception - indicates test failure
108112
*/
109113
@Test
110114
public void testInterfaceMethodWithCompletionStageObjectReturnIsInvokedAsynchronously() throws Exception{
@@ -135,6 +139,8 @@ public void testInterfaceMethodWithCompletionStageObjectReturnIsInvokedAsynchron
135139
/**
136140
* Tests that the MP Rest Client implementation uses the specified
137141
* ExecutorService.
142+
*
143+
* @throws Exception - indicates test failure
138144
*/
139145
@Test
140146
public void testExecutorService() throws Exception{
@@ -181,6 +187,8 @@ public Thread newThread(Runnable r) {
181187
* on the calling thread. It uses an
182188
* <code>AsyncInvocationInterceptorFactory</code> provider to copy the
183189
* ThreadLocal value from the calling thread to the async thread.
190+
*
191+
* @throws Exception - indicates test failure
184192
*/
185193
@Test
186194
public void testAsyncInvocationInterceptorProvider() throws Exception{
@@ -218,7 +226,9 @@ public void testAsyncInvocationInterceptorProvider() throws Exception{
218226
/**
219227
* This test verifies that the <code>RestClientBuilder</code> implementation
220228
* will throw an <code>IllegalArgumentException</code> when a null value is
221-
* passed to the <code>executorService<code> method.
229+
* passed to the <code>executorService</code> method.
230+
*
231+
* @throws IllegalArgumentException - expected when passing null
222232
*/
223233
@Test(expectedExceptions={IllegalArgumentException.class})
224234
public void testNullExecutorServiceThrowsIllegalArgumentException() {

0 commit comments

Comments
 (0)