Skip to content
This repository was archived by the owner on Sep 24, 2018. It is now read-only.

Commit 0546bd6

Browse files
committed
fix javadoc warnings
Signed-off-by: Lukas Jungmann <[email protected]>
1 parent ff59366 commit 0546bd6

35 files changed

+557
-394
lines changed

api/src/main/java/javax/xml/ws/Action.java

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/*
22
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
33
*
4-
* Copyright (c) 2005-2015 Oracle and/or its affiliates. All rights reserved.
4+
* Copyright (c) 2005-2017 Oracle and/or its affiliates. All rights reserved.
55
*
66
* The contents of this file are subject to the terms of either the GNU
77
* General Public License Version 2 only ("GPL") or the Common Development
@@ -62,7 +62,7 @@
6262
* <p>
6363
* <b>Example 1</b>: Specify explicit values for {@code Action} message addressing property
6464
* for {@code input} and {@code output} messages.
65-
*
65+
*
6666
* <pre>
6767
* {@literal @}WebService(targetNamespace="http://example.com/numbers")
6868
* public class AddNumbersImpl {
@@ -143,21 +143,27 @@
143143
public @interface Action {
144144
/**
145145
* Explicit value of the WS-Addressing {@code Action} message addressing property for the {@code input}
146-
* message of the operation.
146+
* message of the operation.
147+
*
148+
* @return {@code Action} message addressing property for the {@code input} message
147149
*/
148150
String input() default "";
149151

150152
/**
151153
* Explicit value of the WS-Addressing {@code Action} message addressing property for the {@code output}
152-
* message of the operation.
154+
* message of the operation.
155+
*
156+
* @return {@code Action} message addressing property for the {@code output} message
153157
*/
154158
String output() default "";
155-
159+
156160
/**
157161
* Explicit value of the WS-Addressing {@code Action} message addressing property for the {@code fault}
158162
* message(s) of the operation. Each exception that is mapped to a fault and requires an explicit WS-Addressing
159163
* {@code Action} message addressing property, needs to be specified as a value in this property
160164
* using {@link FaultAction} annotation.
165+
*
166+
* @return {@code Action} message addressing property for the {@code fault} message(s)
161167
*/
162168
FaultAction[] fault() default { };
163169
}

api/src/main/java/javax/xml/ws/AsyncHandler.java

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/*
22
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
33
*
4-
* Copyright (c) 2005-2015 Oracle and/or its affiliates. All rights reserved.
4+
* Copyright (c) 2005-2017 Oracle and/or its affiliates. All rights reserved.
55
*
66
* The contents of this file are subject to the terms of either the GNU
77
* General Public License Version 2 only ("GPL") or the Common Development
@@ -44,6 +44,7 @@
4444
* clients that wish to receive callback notification of the completion of
4545
* service endpoint operations invoked asynchronously.
4646
*
47+
* @param <T> The type of the message or payload
4748
* @since 1.6, JAX-WS 2.0
4849
**/
4950
public interface AsyncHandler<T> {

api/src/main/java/javax/xml/ws/BindingProvider.java

Lines changed: 36 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/*
22
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
33
*
4-
* Copyright (c) 2005-2015 Oracle and/or its affiliates. All rights reserved.
4+
* Copyright (c) 2005-2017 Oracle and/or its affiliates. All rights reserved.
55
*
66
* The contents of this file are subject to the terms of either the GNU
77
* General Public License Version 2 only ("GPL") or the Common Development
@@ -43,7 +43,7 @@
4343
import java.util.Map;
4444
import javax.xml.ws.wsaddressing.W3CEndpointReference;
4545

46-
/**
46+
/**
4747
* The {@code BindingProvider} interface provides access to the
4848
* protocol binding and associated context objects for request and
4949
* response message processing.
@@ -53,21 +53,21 @@
5353
* @see javax.xml.ws.Binding
5454
**/
5555
public interface BindingProvider {
56-
/**
56+
/**
5757
* Standard property: User name for authentication.
5858
* <p>Type: {@code java.lang.String}
5959
**/
6060
public static final String USERNAME_PROPERTY =
6161
"javax.xml.ws.security.auth.username";
62-
63-
/**
62+
63+
/**
6464
* Standard property: Password for authentication.
6565
* <p>Type: {@code java.lang.String}
6666
**/
6767
public static final String PASSWORD_PROPERTY =
6868
"javax.xml.ws.security.auth.password";
69-
70-
/**
69+
70+
/**
7171
* Standard property: Target service endpoint address. The
7272
* URI scheme for the endpoint address specification MUST
7373
* correspond to the protocol/transport binding for the
@@ -76,8 +76,8 @@ public interface BindingProvider {
7676
**/
7777
public static final String ENDPOINT_ADDRESS_PROPERTY =
7878
"javax.xml.ws.service.endpoint.address";
79-
80-
/**
79+
80+
/**
8181
* Standard property: This boolean property is used by a service
8282
* client to indicate whether or not it wants to participate in
8383
* a session with a service endpoint. If this property is set to
@@ -88,38 +88,38 @@ public interface BindingProvider {
8888
**/
8989
public static final String SESSION_MAINTAIN_PROPERTY =
9090
"javax.xml.ws.session.maintain";
91-
92-
/**
93-
* Standard property for SOAPAction. This boolean property
94-
* indicates whether or not the value of the
91+
92+
/**
93+
* Standard property for SOAPAction. This boolean property
94+
* indicates whether or not the value of the
9595
* {@code javax.xml.ws.soap.http.soapaction.uri} property
96-
* is used for the value of the SOAPAction. The
96+
* is used for the value of the SOAPAction. The
9797
* default value of this property is {@code false} indicating
98-
* that the
98+
* that the
9999
* {@code javax.xml.ws.soap.http.soapaction.uri} property
100-
* is not used for the value of the SOAPAction, however,
101-
* if WS-Addressing is enabled, the default value is
100+
* is not used for the value of the SOAPAction, however,
101+
* if WS-Addressing is enabled, the default value is
102102
* {@code true}.
103-
*
103+
*
104104
* <p>Type: {@code java.lang.Boolean}
105105
**/
106106
public static final String SOAPACTION_USE_PROPERTY =
107107
"javax.xml.ws.soap.http.soapaction.use";
108-
108+
109109
/**
110-
* Standard property for SOAPAction. Indicates the SOAPAction
110+
* Standard property for SOAPAction. Indicates the SOAPAction
111111
* URI if the {@code javax.xml.ws.soap.http.soapaction.use}
112112
* property is set to {@code true}. If WS-Addressing
113-
* is enabled, this value will also be used for the value of the
114-
* WS-Addressing Action header. If this property is not set,
113+
* is enabled, this value will also be used for the value of the
114+
* WS-Addressing Action header. If this property is not set,
115115
* the default SOAPAction and WS-Addressing Action will be sent.
116116
*
117117
* <p>Type: {@code java.lang.String}
118118
**/
119119
public static final String SOAPACTION_URI_PROPERTY =
120120
"javax.xml.ws.soap.http.soapaction.uri";
121121

122-
/**
122+
/**
123123
* Get the context that is used to initialize the message context
124124
* for request messages.
125125
*
@@ -130,8 +130,8 @@ public interface BindingProvider {
130130
* @return The context that is used in processing request messages.
131131
**/
132132
Map<String, Object> getRequestContext();
133-
134-
/**
133+
134+
/**
135135
* Get the context that resulted from processing a response message.
136136
*
137137
* The returned context is for the most recently completed synchronous
@@ -143,16 +143,16 @@ public interface BindingProvider {
143143
* response messages.
144144
**/
145145
Map<String, Object> getResponseContext();
146-
147-
/**
146+
147+
/**
148148
* Get the Binding for this binding provider.
149149
*
150150
* @return The Binding for this binding provider.
151151
**/
152152
Binding getBinding();
153-
154-
155-
153+
154+
155+
156156
/**
157157
* Returns the {@code EndpointReference} associated with
158158
* this {@code BindingProvider} instance.
@@ -164,21 +164,22 @@ public interface BindingProvider {
164164
* @return EndpointReference of the target endpoint associated with this
165165
* {@code BindingProvider} instance.
166166
*
167-
* @throws java.lang.UnsupportedOperationException If this
167+
* @throws java.lang.UnsupportedOperationException If this
168168
* {@code BindingProvider} uses the XML/HTTP binding.
169169
*
170170
* @see W3CEndpointReference
171171
*
172172
* @since 1.6, JAX-WS 2.1
173173
*/
174174
public EndpointReference getEndpointReference();
175-
176-
175+
176+
177177
/**
178178
* Returns the {@code EndpointReference} associated with
179179
* this {@code BindingProvider} instance. The instance
180180
* returned will be of type {@code clazz}.
181181
*
182+
* @param <T> the type of {@code EndpointReference}
182183
* @param clazz Specifies the type of {@code EndpointReference}
183184
* that MUST be returned.
184185
@@ -188,10 +189,10 @@ public interface BindingProvider {
188189
189190
* @throws WebServiceException If the Class {@code clazz}
190191
* is not supported by this implementation.
191-
* @throws java.lang.UnsupportedOperationException If this
192+
* @throws java.lang.UnsupportedOperationException If this
192193
* {@code BindingProvider} uses the XML/HTTP binding.
193194
*
194195
* @since 1.6, JAX-WS 2.1
195196
*/
196-
public <T extends EndpointReference> T getEndpointReference(Class<T> clazz);
197+
public <T extends EndpointReference> T getEndpointReference(Class<T> clazz);
197198
}

api/src/main/java/javax/xml/ws/BindingType.java

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/*
22
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
33
*
4-
* Copyright (c) 2005-2015 Oracle and/or its affiliates. All rights reserved.
4+
* Copyright (c) 2005-2017 Oracle and/or its affiliates. All rights reserved.
55
*
66
* The contents of this file are subject to the terms of either the GNU
77
* General Public License Version 2 only ("GPL") or the Common Development
@@ -45,13 +45,15 @@
4545
import java.lang.annotation.ElementType;
4646
import java.lang.annotation.Retention;
4747
import java.lang.annotation.RetentionPolicy;
48+
import javax.xml.ws.http.HTTPBinding;
49+
import javax.xml.ws.soap.SOAPBinding;
4850

4951
/**
5052
* The {@code BindingType} annotation is used to
5153
* specify the binding to use for a web service
5254
* endpoint implementation class.
5355
* <p>
54-
* This annotation may be overriden programmatically or via
56+
* This annotation may be overridden programmatically or via
5557
* deployment descriptors, depending on the platform in use.
5658
*
5759
* @since 1.6, JAX-WS 2.0
@@ -62,12 +64,11 @@
6264
@Documented
6365
public @interface BindingType {
6466
/**
65-
* A binding identifier (a URI).
66-
* If not specified, the default is the SOAP 1.1 / HTTP binding.
67-
* <p>
68-
* See the {@code SOAPBinding} and {@code HTTPBinding}
67+
* A binding identifier (a URI). If not specified, the default is the SOAP 1.1 / HTTP binding.<br>
68+
* See the {@link SOAPBinding} and {@link HTTPBinding}
6969
* for the definition of the standard binding identifiers.
7070
*
71+
* @return A binding identifier (a URI)
7172
* @see javax.xml.ws.Binding
7273
* @see javax.xml.ws.soap.SOAPBinding#SOAP11HTTP_BINDING
7374
* @see javax.xml.ws.soap.SOAPBinding#SOAP12HTTP_BINDING

api/src/main/java/javax/xml/ws/Dispatch.java

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/*
22
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
33
*
4-
* Copyright (c) 2005-2015 Oracle and/or its affiliates. All rights reserved.
4+
* Copyright (c) 2005-2017 Oracle and/or its affiliates. All rights reserved.
55
*
66
* The contents of this file are subject to the terms of either the GNU
77
* General Public License Version 2 only ("GPL") or the Common Development
@@ -49,12 +49,13 @@
4949
* class acts as a factory for the creation of {@code Dispatch}
5050
* instances.
5151
*
52+
* @param <T> The type of the message or payload
5253
* @since 1.6, JAX-WS 2.0
5354
**/
5455
public interface Dispatch<T> extends BindingProvider {
5556

5657
/** Invoke a service operation synchronously.
57-
*
58+
*
5859
* The client is responsible for ensuring that the {@code msg} object
5960
* when marshalled is formed according to the requirements of the protocol
6061
* binding in use.
@@ -78,7 +79,7 @@ public interface Dispatch<T> extends BindingProvider {
7879
* The client is responsible for ensuring that the {@code msg} object
7980
* when marshalled is formed according to the requirements of the protocol
8081
* binding in use.
81-
*
82+
*
8283
* @param msg An object that will form the message or payload of
8384
* the message used to invoke the operation.
8485
* @return The response message or message payload to the

0 commit comments

Comments
 (0)