You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cxf.apache.org by co...@apache.org on 2020/01/07 15:23:06 UTC
[cxf] branch master updated: More javadoc fixes
This is an automated email from the ASF dual-hosted git repository.
coheigea pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/cxf.git
The following commit(s) were added to refs/heads/master by this push:
new f9c95c5 More javadoc fixes
f9c95c5 is described below
commit f9c95c5d87a7b948896d8288d2009e03c6313eb7
Author: Colm O hEigeartaigh <co...@apache.org>
AuthorDate: Tue Jan 7 15:22:49 2020 +0000
More javadoc fixes
---
.../java/org/apache/cxf/jca/inbound/MDBActivationWork.java | 6 +-----
.../main/java/org/apache/cxf/aegis/util/NamespaceHelper.java | 7 +++++--
.../apache/cxf/clustering/AbstractStaticFailoverStrategy.java | 4 ++--
.../org/apache/cxf/endpoint/dynamic/DynamicClientFactory.java | 11 ++++++-----
.../oauth2/grants/owner/ResourceOwnerLoginHandler.java | 4 ++--
.../src/main/java/org/apache/cxf/transport/http/Cookies.java | 3 +--
.../org/apache/cxf/transport/servlet/ServletDestination.java | 4 ++--
.../apache/cxf/ws/addressing/impl/InternalContextUtils.java | 7 +++----
.../org/apache/cxf/ws/addressing/soap/VersionTransformer.java | 5 +++--
rt/ws/rm/src/main/java/org/apache/cxf/ws/rm/Destination.java | 6 +-----
10 files changed, 26 insertions(+), 31 deletions(-)
diff --git a/integration/jca/src/main/java/org/apache/cxf/jca/inbound/MDBActivationWork.java b/integration/jca/src/main/java/org/apache/cxf/jca/inbound/MDBActivationWork.java
index 4b398a4..cd6f4d4 100644
--- a/integration/jca/src/main/java/org/apache/cxf/jca/inbound/MDBActivationWork.java
+++ b/integration/jca/src/main/java/org/apache/cxf/jca/inbound/MDBActivationWork.java
@@ -100,7 +100,7 @@ public class MDBActivationWork implements Work {
}
/**
- * @param endpoint
+ * @param invoker
* @param classLoader
*/
private void activate(MDBInvoker invoker, ClassLoader classLoader) {
@@ -233,10 +233,6 @@ public class MDBActivationWork implements Work {
return endpoint.getServer(factory.getAddress());
}
- /**
- * @param str
- * @return
- */
private List<String> getListOfString(String str) {
if (str == null) {
return null;
diff --git a/rt/databinding/aegis/src/main/java/org/apache/cxf/aegis/util/NamespaceHelper.java b/rt/databinding/aegis/src/main/java/org/apache/cxf/aegis/util/NamespaceHelper.java
index 2c5b19b..21218a5 100644
--- a/rt/databinding/aegis/src/main/java/org/apache/cxf/aegis/util/NamespaceHelper.java
+++ b/rt/databinding/aegis/src/main/java/org/apache/cxf/aegis/util/NamespaceHelper.java
@@ -47,7 +47,8 @@ public final class NamespaceHelper {
/**
* Create a unique namespace uri/prefix combination.
*
- * @param nsUri
+ * @param element
+ * @param namespaceURI namespace
* @return The namespace with the specified URI. If one doesn't exist, one
* is created.
*/
@@ -74,7 +75,9 @@ public final class NamespaceHelper {
/**
* Create a unique namespace uri/prefix combination.
*
- * @param nsUri
+ * @param writer target writer.
+ * @param namespaceURI namespace
+ * @param declare whether to declare to the stream.
* @return The namespace with the specified URI. If one doesn't exist, one
* is created.
* @throws XMLStreamException
diff --git a/rt/features/clustering/src/main/java/org/apache/cxf/clustering/AbstractStaticFailoverStrategy.java b/rt/features/clustering/src/main/java/org/apache/cxf/clustering/AbstractStaticFailoverStrategy.java
index 599f5e8..229bbac 100644
--- a/rt/features/clustering/src/main/java/org/apache/cxf/clustering/AbstractStaticFailoverStrategy.java
+++ b/rt/features/clustering/src/main/java/org/apache/cxf/clustering/AbstractStaticFailoverStrategy.java
@@ -71,7 +71,7 @@ public abstract class AbstractStaticFailoverStrategy implements FailoverStrategy
/**
* Select one of the alternate addresses for a retried invocation.
*
- * @param a List of alternate addresses if available
+ * @param alternates a List of alternate addresses if available
* @return the selected address
*/
public String selectAlternateAddress(List<String> alternates) {
@@ -103,7 +103,7 @@ public abstract class AbstractStaticFailoverStrategy implements FailoverStrategy
/**
* Select one of the alternate endpoints for a retried invocation.
*
- * @param a List of alternate endpoints if available
+ * @param alternates a List of alternate endpoints if available
* @return the selected endpoint
*/
public Endpoint selectAlternateEndpoint(List<Endpoint> alternates) {
diff --git a/rt/frontend/simple/src/main/java/org/apache/cxf/endpoint/dynamic/DynamicClientFactory.java b/rt/frontend/simple/src/main/java/org/apache/cxf/endpoint/dynamic/DynamicClientFactory.java
index 44b0608..e8e8d41 100644
--- a/rt/frontend/simple/src/main/java/org/apache/cxf/endpoint/dynamic/DynamicClientFactory.java
+++ b/rt/frontend/simple/src/main/java/org/apache/cxf/endpoint/dynamic/DynamicClientFactory.java
@@ -185,12 +185,13 @@ public class DynamicClientFactory {
* Create a new <code>Client</code> instance using the WSDL to be loaded
* from the specified URL and using the current classloading context.
*
- * @param wsdlURL the URL to load
- * @return
+ * @param wsdlUrl the URL to load
+ * @return a new Client loaded using the wsdlUrl parameter
*/
public Client createClient(String wsdlUrl) {
return createClient(wsdlUrl, (QName)null, (QName)null);
}
+
public Client createClient(String wsdlUrl, List<String> bindingFiles) {
return createClient(wsdlUrl, (QName)null, (QName)null, bindingFiles);
}
@@ -200,8 +201,8 @@ public class DynamicClientFactory {
* Create a new <code>Client</code> instance using the WSDL to be loaded
* from the specified URL and using the current classloading context.
*
- * @param wsdlURL the URL to load
- * @return
+ * @param wsdlUrl the URL to load
+ * @return a new Client loaded using the wsdlUrl parameter
*/
public Client createClient(URL wsdlUrl) {
return createClient(wsdlUrl, (QName)null, (QName)null);
@@ -443,7 +444,7 @@ public class DynamicClientFactory {
}
protected SchemaCompiler createSchemaCompiler() {
- return JAXBUtils.createSchemaCompilerWithDefaultAllocator(new HashSet<>());
+ return JAXBUtils.createSchemaCompilerWithDefaultAllocator(new HashSet<>());
}
protected void applySchemaCompilerOptions(SchemaCompiler compiler) {
diff --git a/rt/rs/security/oauth-parent/oauth2/src/main/java/org/apache/cxf/rs/security/oauth2/grants/owner/ResourceOwnerLoginHandler.java b/rt/rs/security/oauth-parent/oauth2/src/main/java/org/apache/cxf/rs/security/oauth2/grants/owner/ResourceOwnerLoginHandler.java
index dda599e..5044b26 100644
--- a/rt/rs/security/oauth-parent/oauth2/src/main/java/org/apache/cxf/rs/security/oauth2/grants/owner/ResourceOwnerLoginHandler.java
+++ b/rt/rs/security/oauth-parent/oauth2/src/main/java/org/apache/cxf/rs/security/oauth2/grants/owner/ResourceOwnerLoginHandler.java
@@ -27,8 +27,8 @@ public interface ResourceOwnerLoginHandler {
* Create a {@link UserSubject} for the name and password parameters, or return null if the name and password
* are invalid.
* @param client using the resource owner grant
- * @param resource owner name
- * @param resource owner password
+ * @param name owner name
+ * @param password owner password
* @return A {@link UserSubject} representing the user, or null.
*/
UserSubject createSubject(Client client, String name, String password);
diff --git a/rt/transports/http/src/main/java/org/apache/cxf/transport/http/Cookies.java b/rt/transports/http/src/main/java/org/apache/cxf/transport/http/Cookies.java
index 0724309..6ae7daf 100644
--- a/rt/transports/http/src/main/java/org/apache/cxf/transport/http/Cookies.java
+++ b/rt/transports/http/src/main/java/org/apache/cxf/transport/http/Cookies.java
@@ -58,8 +58,7 @@ public class Cookies {
/**
* Given a list of current cookies and a new Set-Cookie: request, construct
* a new set of current cookies and return it.
- * @param current Set of previously set cookies
- * @param header Text of a Set-Cookie: header
+ * @param headers Text of the Set-Cookie: headers
* @return New set of cookies
*/
private void handleSetCookie(List<String> headers) {
diff --git a/rt/transports/http/src/main/java/org/apache/cxf/transport/servlet/ServletDestination.java b/rt/transports/http/src/main/java/org/apache/cxf/transport/servlet/ServletDestination.java
index 9af952c..aceb058 100644
--- a/rt/transports/http/src/main/java/org/apache/cxf/transport/servlet/ServletDestination.java
+++ b/rt/transports/http/src/main/java/org/apache/cxf/transport/servlet/ServletDestination.java
@@ -38,9 +38,9 @@ public class ServletDestination extends AbstractHTTPDestination implements Servl
* Constructor, allowing subsititution of configuration.
*
* @param b the associated Bus
- * @param ci the associated conduit initiator
+ * @param registry the destination registry
* @param ei the endpoint info of the destination
- * @param cfg the configuration
+ * @param path the path
* @throws IOException
*/
public ServletDestination(Bus b,
diff --git a/rt/ws/addr/src/main/java/org/apache/cxf/ws/addressing/impl/InternalContextUtils.java b/rt/ws/addr/src/main/java/org/apache/cxf/ws/addressing/impl/InternalContextUtils.java
index c56f9c6..8c46dac 100644
--- a/rt/ws/addr/src/main/java/org/apache/cxf/ws/addressing/impl/InternalContextUtils.java
+++ b/rt/ws/addr/src/main/java/org/apache/cxf/ws/addressing/impl/InternalContextUtils.java
@@ -324,7 +324,7 @@ final class InternalContextUtils {
"Executor queue is full, use the caller thread."
+ " Users can specify a larger executor queue to avoid this.");
// only block the thread if the prop is unset or set to false, otherwise let it go
- if (!MessageUtils.getContextualBoolean(inMessage,
+ if (!MessageUtils.getContextualBoolean(inMessage,
"org.apache.cxf.oneway.rejected_execution_exception")) {
//the executor queue is full, so run the task in the caller thread
inMessage.getInterceptorChain().resume();
@@ -501,7 +501,6 @@ final class InternalContextUtils {
/**
* Get action from attributes on MessageInfo
*
- * @param bindingOpInfo the current BindingOperationInfo
* @param msgInfo the current MessageInfo
* @return the action if set
*/
@@ -539,8 +538,8 @@ final class InternalContextUtils {
/**
* Get the Executor for this invocation.
- * @param endpoint
- * @return
+ * @param message the current Message
+ * @return the executor for this invocation
*/
private static Executor getExecutor(final Message message) {
Endpoint endpoint = message.getExchange().getEndpoint();
diff --git a/rt/ws/addr/src/main/java/org/apache/cxf/ws/addressing/soap/VersionTransformer.java b/rt/ws/addr/src/main/java/org/apache/cxf/ws/addressing/soap/VersionTransformer.java
index f307f7c..605c26f 100644
--- a/rt/ws/addr/src/main/java/org/apache/cxf/ws/addressing/soap/VersionTransformer.java
+++ b/rt/ws/addr/src/main/java/org/apache/cxf/ws/addressing/soap/VersionTransformer.java
@@ -74,12 +74,13 @@ public class VersionTransformer extends org.apache.cxf.ws.addressing.VersionTran
/**
* Encode message in exposed version.
*
+ * @param message The message to be encoded
* @param exposeAs specifies the WS-Addressing version to expose
* @param value the value to encode
* @param localName the localName for the header
* @param clz the class
- * @param header the SOAP header element
* @param marshaller the JAXB context to use
+ * @param mustUnderstand whether mustUnderstand is true
*/
public <T> void encodeAsExposed(SoapMessage message,
String exposeAs, T value,
@@ -181,7 +182,7 @@ public class VersionTransformer extends org.apache.cxf.ws.addressing.VersionTran
static {
Set<QName> headers = new HashSet<>();
headers.addAll(Names.HEADERS);
-
+
headers.add(new QName(Names200408.WSA_NAMESPACE_NAME, Names.WSA_FROM_NAME));
headers.add(new QName(Names200408.WSA_NAMESPACE_NAME, Names.WSA_TO_NAME));
headers.add(new QName(Names200408.WSA_NAMESPACE_NAME, Names.WSA_REPLYTO_NAME));
diff --git a/rt/ws/rm/src/main/java/org/apache/cxf/ws/rm/Destination.java b/rt/ws/rm/src/main/java/org/apache/cxf/ws/rm/Destination.java
index 91f292d..122925a 100644
--- a/rt/ws/rm/src/main/java/org/apache/cxf/ws/rm/Destination.java
+++ b/rt/ws/rm/src/main/java/org/apache/cxf/ws/rm/Destination.java
@@ -106,11 +106,7 @@ public class Destination extends AbstractEndpoint {
* response will be sent to the acksTo address onto which the acknowldegment
* can be piggybacked.
*
- * @param sequenceType the sequenceType object that includes identifier and
- * message number (and possibly a lastMessage element) for the
- * message to be acknowledged)
- * @param replyToAddress the replyTo address of the message that carried
- * this sequence information
+ * @param message the message to be acknowledged
* @throws SequenceFault if the sequence specified in
* <code>sequenceType</code> does not exist
*/