5:39 p.m.
Author: rsearls
Date: 2015-03-23 12:39:40 -0400 (Mon, 23 Mar 2015)
New Revision: 19597
Modified:
api/trunk/pom.xml
api/trunk/src/main/java/org/jboss/ws/api/Log.java
api/trunk/src/main/java/org/jboss/ws/api/Messages.java
api/trunk/src/main/java/org/jboss/ws/api/addressing/MAPBuilder.java
api/trunk/src/main/java/org/jboss/ws/api/annotation/EndpointConfig.java
api/trunk/src/main/java/org/jboss/ws/api/annotation/PolicySets.java
api/trunk/src/main/java/org/jboss/ws/api/annotation/WebContext.java
api/trunk/src/main/java/org/jboss/ws/api/configuration/AbstractClientFeature.java
api/trunk/src/main/java/org/jboss/ws/api/monitoring/Record.java
api/trunk/src/main/java/org/jboss/ws/api/monitoring/RecordFilter.java
api/trunk/src/main/java/org/jboss/ws/api/monitoring/RecordProcessor.java
api/trunk/src/main/java/org/jboss/ws/api/tools/WSContractProvider.java
api/trunk/src/main/java/org/jboss/ws/api/util/DOMUtils.java
Log:
"[JBWS-3878] resolve javaDoc warnings for jdk8 and 7"
Modified: api/trunk/pom.xml
===================================================================
--- api/trunk/pom.xml 2015-03-23 15:38:24 UTC (rev 19596)
+++ api/trunk/pom.xml 2015-03-23 16:39:40 UTC (rev 19597)
@@ -27,6 +27,7 @@
<jboss-logging.version>3.1.2.GA</jboss-logging.version>
<jboss-logging-processor.version>1.0.3.Final</jboss-logging-processor.version>
<junit.version>3.8.2</junit.version>
+
<jboss-logging-annotations.version>1.2.0.Final</jboss-logging-annotations.version>
</properties>
<!-- Dependencies -->
@@ -45,8 +46,13 @@
<version>${jboss-logging-processor.version}</version>
<scope>provided</scope>
</dependency>
+ <dependency>
+ <groupId>org.jboss.logging</groupId>
+ <artifactId>jboss-logging-annotations</artifactId>
+ <version>${jboss-logging-annotations.version}</version>
+ <scope>provided</scope>
+ </dependency>
-
<!-- test dependencies -->
<dependency>
<groupId>junit</groupId>
Modified: api/trunk/src/main/java/org/jboss/ws/api/Log.java
===================================================================
--- api/trunk/src/main/java/org/jboss/ws/api/Log.java 2015-03-23 15:38:24 UTC (rev 19596)
+++ api/trunk/src/main/java/org/jboss/ws/api/Log.java 2015-03-23 16:39:40 UTC (rev 19597)
@@ -26,9 +26,9 @@
import static org.jboss.logging.Logger.Level.WARN;
import org.jboss.logging.BasicLogger;
-import org.jboss.logging.LogMessage;
-import org.jboss.logging.Message;
-import org.jboss.logging.MessageLogger;
+import org.jboss.logging.annotations.LogMessage;
+import org.jboss.logging.annotations.Message;
+import org.jboss.logging.annotations.MessageLogger;
/**
* JBossWS API log messages
Modified: api/trunk/src/main/java/org/jboss/ws/api/Messages.java
===================================================================
--- api/trunk/src/main/java/org/jboss/ws/api/Messages.java 2015-03-23 15:38:24 UTC (rev
19596)
+++ api/trunk/src/main/java/org/jboss/ws/api/Messages.java 2015-03-23 16:39:40 UTC (rev
19597)
@@ -21,9 +21,9 @@
*/
package org.jboss.ws.api;
-import org.jboss.logging.Cause;
-import org.jboss.logging.Message;
-import org.jboss.logging.MessageBundle;
+import org.jboss.logging.annotations.Cause;
+import org.jboss.logging.annotations.Message;
+import org.jboss.logging.annotations.MessageBundle;
/**
* JBossWS API exception messages
Modified: api/trunk/src/main/java/org/jboss/ws/api/addressing/MAPBuilder.java
===================================================================
--- api/trunk/src/main/java/org/jboss/ws/api/addressing/MAPBuilder.java 2015-03-23
15:38:24 UTC (rev 19596)
+++ api/trunk/src/main/java/org/jboss/ws/api/addressing/MAPBuilder.java 2015-03-23
16:39:40 UTC (rev 19597)
@@ -66,14 +66,17 @@
/**
* Creates a new {@link org.jboss.ws.api.addressing.MAPEndpoint} instance
- *
+ *
+ * @param address endpoint address
* @return a {@link org.jboss.ws.api.addressing.MAPEndpoint} instance
*/
public MAPEndpoint newEndpoint(String address);
/**
* Creates a new {@link org.jboss.ws.api.addressing.MAPRelatesTo} instance
- *
+ *
+ * @param id identifier
+ * @param type Qname
* @return a {@link org.jboss.ws.api.addressing.MAPRelatesTo} instance
*/
public MAPRelatesTo newRelatesTo(String id, QName type);
Modified: api/trunk/src/main/java/org/jboss/ws/api/annotation/EndpointConfig.java
===================================================================
--- api/trunk/src/main/java/org/jboss/ws/api/annotation/EndpointConfig.java 2015-03-23
15:38:24 UTC (rev 19596)
+++ api/trunk/src/main/java/org/jboss/ws/api/annotation/EndpointConfig.java 2015-03-23
16:39:40 UTC (rev 19597)
@@ -39,6 +39,8 @@
/**
* The configName gives the configuration name that must be present in the
configuration given by configFile.
* If configName is not specified, the standard endpoint configuration is used.
+ *
+ * @return string
*/
String configName() default "";
@@ -46,6 +48,7 @@
* The configFile element is a URL or resource name for the configuration.
* The default value references the current AS configuration.
*
+ * @return string
*/
String configFile() default "";
}
Modified: api/trunk/src/main/java/org/jboss/ws/api/annotation/PolicySets.java
===================================================================
--- api/trunk/src/main/java/org/jboss/ws/api/annotation/PolicySets.java 2015-03-23
15:38:24 UTC (rev 19596)
+++ api/trunk/src/main/java/org/jboss/ws/api/annotation/PolicySets.java 2015-03-23
16:39:40 UTC (rev 19597)
@@ -39,7 +39,8 @@
/**
* The names of the policy sets to be applied
- *
+ *
+ * @return string
*/
String[] value();
}
Modified: api/trunk/src/main/java/org/jboss/ws/api/annotation/WebContext.java
===================================================================
--- api/trunk/src/main/java/org/jboss/ws/api/annotation/WebContext.java 2015-03-23
15:38:24 UTC (rev 19596)
+++ api/trunk/src/main/java/org/jboss/ws/api/annotation/WebContext.java 2015-03-23
16:39:40 UTC (rev 19597)
@@ -40,7 +40,9 @@
* The contextRoot element specifies the context root that the web service endpoint is
deployed to.
* If it is not specified it will be derived from the deployment short name.
*
- * Applies to server side port components only.
+ * Applies to server side port components only
+ *
+ * @return string
*/
String contextRoot() default "";
@@ -48,6 +50,8 @@
* The virtual host that the web service endpoint is deployed to.
*
* Applies to server side port components only.
+ *
+ * @return string
*/
String virtualHost() default "";
@@ -55,7 +59,9 @@
* Relative path that is appended to the contextRoot to form fully qualified
* endpoint address for the web service endpoint.
*
- * Applies to server side port components only.
+ * Applies to server side port components only.
+ *
+ * @return string
*/
String urlPattern() default "";
@@ -68,6 +74,8 @@
* be specified.
*
* @see AuthMethod
+ *
+ * @return string
*/
String authMethod() default "";
@@ -84,6 +92,8 @@
* CONFIDENTIAL flag will indicate that the use of SSL is required.
*
* @see TransportGuarantee
+ *
+ * @return string
*/
String transportGuarantee() default "";
@@ -91,12 +101,16 @@
* A secure endpoint does not secure wsdl access by default.
* Explicitly setting secureWSDLAccess overrides this behaviour.
*
- * Protect access to WSDL. See http://jira.jboss.org/jira/browse/JBWS-723
+ * Protect access to WSDL. See http://jira.jboss.org/jira/browse/JBWS-723
+ *
+ * @return boolean
*/
boolean secureWSDLAccess() default false;
/**
* Description of the resource being accessed
+ *
+ * @return string
*/
String realmName() default "";
Modified:
api/trunk/src/main/java/org/jboss/ws/api/configuration/AbstractClientFeature.java
===================================================================
---
api/trunk/src/main/java/org/jboss/ws/api/configuration/AbstractClientFeature.java 2015-03-23
15:38:24 UTC (rev 19596)
+++
api/trunk/src/main/java/org/jboss/ws/api/configuration/AbstractClientFeature.java 2015-03-23
16:39:40 UTC (rev 19597)
@@ -42,7 +42,7 @@
* Initializes the provided JAXWS client component; this is called by the
* the JBossWS impl of JAXWS Provider.
*
- * @param obj
+ * @param obj client component
*/
public void initialize(Object obj)
{
@@ -55,7 +55,7 @@
/**
* Initializes the provided BindingProvider instance
*
- * @param bp
+ * @param bp binding provider
*/
protected void initializeBindingProvider(BindingProvider bp)
{
Modified: api/trunk/src/main/java/org/jboss/ws/api/monitoring/Record.java
===================================================================
--- api/trunk/src/main/java/org/jboss/ws/api/monitoring/Record.java 2015-03-23 15:38:24
UTC (rev 19596)
+++ api/trunk/src/main/java/org/jboss/ws/api/monitoring/Record.java 2015-03-23 16:39:40
UTC (rev 19597)
@@ -54,7 +54,7 @@
/**
* Sets the groupID
*
- * @param groupID
+ * @param groupID id
*/
public void setGroupID(String groupID);
@@ -68,7 +68,7 @@
/**
* Sets the date of the record
*
- * @param date
+ * @param date date
*/
public void setDate(Date date);
@@ -82,7 +82,7 @@
/**
* Sets the source host
*
- * @param host
+ * @param host source host
*/
public void setSourceHost(String host);
@@ -96,7 +96,7 @@
/**
* Sets the destination host
*
- * @param host
+ * @param host destination host
*/
public void setDestinationHost(String host);
@@ -110,7 +110,7 @@
/**
* Sets the message type
*
- * @param type
+ * @param type message type
*/
public void setMessageType(MessageType type);
@@ -125,7 +125,7 @@
/**
* Sets the SOAP message envelope
*
- * @param envelope
+ * @param envelope SOAP message envelope
*/
public void setEnvelope(String envelope);
@@ -139,15 +139,15 @@
/**
* Adds a HTTP header to the record
*
- * @param key
- * @param value
+ * @param key id
+ * @param value value
*/
public void addHeaders(String key, List<String> value);
/**
* Sets the HTTP headers of the record
*
- * @param headers
+ * @param headers HTTP headers
*/
public void setHeaders(Map<String, List<String>> headers);
@@ -161,7 +161,7 @@
/**
* Sets the record's operation
*
- * @param operation
+ * @param operation record operation
*/
public void setOperation(QName operation);
}
Modified: api/trunk/src/main/java/org/jboss/ws/api/monitoring/RecordFilter.java
===================================================================
--- api/trunk/src/main/java/org/jboss/ws/api/monitoring/RecordFilter.java 2015-03-23
15:38:24 UTC (rev 19596)
+++ api/trunk/src/main/java/org/jboss/ws/api/monitoring/RecordFilter.java 2015-03-23
16:39:40 UTC (rev 19597)
@@ -33,11 +33,17 @@
{
/**
* Returns true if the filter matches the given record.
+ *
+ * @param record record
+ * @return true success
*/
boolean match(Record record);
/**
* RecordFilters must override Object.clone()
+ *
+ * @return Object recode filter
+ * @throws CloneNotSupportedException exception
*/
Object clone() throws CloneNotSupportedException;
}
Modified: api/trunk/src/main/java/org/jboss/ws/api/monitoring/RecordProcessor.java
===================================================================
--- api/trunk/src/main/java/org/jboss/ws/api/monitoring/RecordProcessor.java 2015-03-23
15:38:24 UTC (rev 19596)
+++ api/trunk/src/main/java/org/jboss/ws/api/monitoring/RecordProcessor.java 2015-03-23
16:39:40 UTC (rev 19597)
@@ -190,6 +190,9 @@
/**
* RecordFilters must override Object.clone()
+ *
+ * @return object
+ * @throws CloneNotSupportedException exception
*/
Object clone() throws CloneNotSupportedException;
}
Modified: api/trunk/src/main/java/org/jboss/ws/api/tools/WSContractProvider.java
===================================================================
--- api/trunk/src/main/java/org/jboss/ws/api/tools/WSContractProvider.java 2015-03-23
15:38:24 UTC (rev 19596)
+++ api/trunk/src/main/java/org/jboss/ws/api/tools/WSContractProvider.java 2015-03-23
16:39:40 UTC (rev 19597)
@@ -142,7 +142,7 @@
* Sets the soap:address to be used for the generated port in the wsdl.
* This is ignored if WSDL generation is disabled.
*
- * @param address
+ * @param address soap address
*/
public abstract void setPortSoapAddress(String address);
Modified: api/trunk/src/main/java/org/jboss/ws/api/util/DOMUtils.java
===================================================================
--- api/trunk/src/main/java/org/jboss/ws/api/util/DOMUtils.java 2015-03-23 15:38:24 UTC
(rev 19596)
+++ api/trunk/src/main/java/org/jboss/ws/api/util/DOMUtils.java 2015-03-23 16:39:40 UTC
(rev 19597)
@@ -65,7 +65,11 @@
*/
public abstract class DOMUtils
{
- /** Get the qname of the given node.
+ /**
+ * Get the qname of the given node.
+ *
+ * @param el node
+ * @return Qname
*/
public static QName getElementQName(Element el)
{
@@ -74,6 +78,10 @@
}
/** Transform the given qualified name into a QName
+ *
+ * @param el node
+ * @param qualifiedName qualified name
+ * @return QName
*/
public static QName resolveQName(Element el, String qualifiedName)
{
@@ -128,6 +136,8 @@
/** Get the value from the given attribute
*
+ * @param el element
+ * @param attrName attribute name
* @return null if the attribute value is empty or the attribute is not present
*/
public static String getAttributeValue(Element el, String attrName)
@@ -137,6 +147,8 @@
/** Get the value from the given attribute
*
+ * @param el element
+ * @param attrName attribute name
* @return null if the attribute value is empty or the attribute is not present
*/
public static String getAttributeValue(Element el, QName attrName)
@@ -153,7 +165,12 @@
return attr;
}
- /** Get the qname value from the given attribute
+ /**
+ * Get the qname value from the given attribute
+ *
+ * @param el element
+ * @param attrName attribute name
+ * @return QName
*/
public static QName getAttributeValueAsQName(Element el, String attrName)
{
@@ -161,7 +178,12 @@
}
- /** Get the qname value from the given attribute
+ /**
+ * Get the qname value from the given attribute
+ *
+ * @param el element
+ * @param attrName attribute name
+ * @return QName
*/
public static QName getAttributeValueAsQName(Element el, QName attrName)
{
@@ -176,14 +198,24 @@
return qname;
}
- /** Get the boolean value from the given attribute
+ /**
+ * Get the boolean value from the given attribute
+ *
+ * @param el element
+ * @param attrName attribute name
+ * @return boolean
*/
public static boolean getAttributeValueAsBoolean(Element el, String attrName)
{
return getAttributeValueAsBoolean(el, new QName(attrName));
}
- /** Get the boolean value from the given attribute
+ /**
+ * Get the boolean value from the given attribute
+ *
+ * @param el element
+ * @param attrName attribute name
+ * @return boolean
*/
public static boolean getAttributeValueAsBoolean(Element el, QName attrName)
{
@@ -192,14 +224,24 @@
return ret;
}
- /** Get the integer value from the given attribute
+ /**
+ * Get the integer value from the given attribute
+ *
+ * @param el element
+ * @param attrName attribute name
+ * @return Integer
*/
public static Integer getAttributeValueAsInteger(Element el, String attrName)
{
return getAttributeValueAsInteger(el, new QName(attrName));
}
- /** Get the integer value from the given attribute
+ /**
+ * Get the integer value from the given attribute
+ *
+ * @param el element
+ * @param attrName attribute name
+ * @return Integer
*/
public static Integer getAttributeValueAsInteger(Element el, QName attrName)
{
@@ -207,7 +249,11 @@
return (attrVal != null ? new Integer(attrVal) : null);
}
- /** Get the attributes as Map<QName, String>
+ /**
+ * Get the attributes as Map<QName, String>
+ *
+ * @param el element
+ * @return Map
*/
public static Map<QName, String> getAttributes(Element el)
{
@@ -225,7 +271,11 @@
return attmap;
}
- /** Copy attributes between elements
+ /**
+ * Copy attributes between elements
+ *
+ * @param destElement element
+ * @param srcElement element
*/
public static void copyAttributes(Element destElement, Element srcElement)
{
@@ -252,7 +302,11 @@
}
}
- /** True if the node has text child elements only
+ /**
+ * True if the node has text child elements only
+ *
+ * @param node start node
+ * @return True if the node has text child
*/
public static boolean hasTextChildNodesOnly(Node node)
{
@@ -271,7 +325,11 @@
return true;
}
- /** True if the node has child elements
+ /**
+ * True if the node has child elements
+ *
+ * @param node start node
+ * @return true when child has elements
*/
public static boolean hasChildElements(Node node)
{
@@ -286,7 +344,11 @@
return false;
}
- /** Gets child elements
+ /**
+ * Gets child elements
+ *
+ * @param node start node
+ * @return Iterator
*/
public static Iterator<Element> getChildElements(Node node)
{
@@ -302,7 +364,11 @@
return list.iterator();
}
- /** Get the concatenated text content, or null.
+ /**
+ * Get the concatenated text content, or null.
+ *
+ * @param node node
+ * @return string
*/
public static String getTextContent(Node node)
{
@@ -322,14 +388,23 @@
return (hasTextContent ? buffer.toString() : null);
}
- /** Gets the first child element
+ /**
+ * Gets the first child element
+ *
+ * @param node start node
+ * @return element
*/
public static Element getFirstChildElement(Node node)
{
return getFirstChildElement(node, false);
}
- /** Gets the first child element
+ /**
+ * Gets the first child element
+ *
+ * @param node child
+ * @param recursive recurse flag
+ * @return element
*/
public static Element getFirstChildElement(Node node, boolean recursive)
{
@@ -337,27 +412,48 @@
}
/** Gets the first child element for a given local name without namespace
+ *
+ * @param node child
+ * @param nodeName name
+ * @return element
*/
public static Element getFirstChildElement(Node node, String nodeName)
{
return getFirstChildElement(node, nodeName, false);
}
- /** Gets the first child element for a given local name without namespace
+ /**
+ * Gets the first child element for a given local name without namespace
+ *
+ * @param node child
+ * @param nodeName name
+ * @param recursive recurse flag
+ * @return element
*/
public static Element getFirstChildElement(Node node, String nodeName, boolean
recursive)
{
return getFirstChildElementIntern(node, new QName(nodeName), recursive);
}
- /** Gets the first child element for a given qname
+ /**
+ * Gets the first child element for a given qname
+ *
+ * @param node child
+ * @param nodeName name
+ * @return element
*/
public static Element getFirstChildElement(Node node, QName nodeName)
{
return getFirstChildElement(node, nodeName, false);
}
- /** Gets the first child element for a given qname
+ /**
+ * Gets the first child element for a given qname
+ *
+ * @param node child
+ * @param nodeName name
+ * @param recursive recurse flag
+ * @return element
*/
public static Element getFirstChildElement(Node node, QName nodeName, boolean
recursive)
{
@@ -375,28 +471,50 @@
return childElement;
}
- /** Gets the child elements for a given local name without namespace
+ /**
+ * Gets the child elements for a given local name without namespace
+ *
+ * @param node child
+ * @param nodeName name
+ * @return Iterator
*/
public static Iterator<Element> getChildElements(Node node, String nodeName)
{
return getChildElements(node, nodeName, false);
}
- /** Gets the child elements for a given local name without namespace
+ /**
+ * Gets the child elements for a given local name without namespace
+ *
+ * @param node child
+ * @param nodeName name
+ * @param recursive recurse flag
+ * @return Iterator
*/
public static Iterator<Element> getChildElements(Node node, String nodeName,
boolean recursive)
{
return getChildElementsIntern(node, new QName(nodeName), recursive);
}
- /** Gets the child element for a given qname
+ /**
+ * Gets the child element for a given qname
+ *
+ * @param node child
+ * @param nodeName name
+ * @return Iterator
*/
public static Iterator<Element> getChildElements(Node node, QName nodeName)
{
return getChildElements(node, nodeName, false);
}
- /** Gets the child element for a given qname
+ /**
+ * Gets the child element for a given qname
+ *
+ * @param node child
+ * @param nodeName name
+ * @param recursive recurse flag
+ * @return Iterator
*/
public static Iterator<Element> getChildElements(Node node, QName nodeName,
boolean recursive)
{
@@ -482,7 +600,11 @@
return getChildElementsAsListIntern(node, nodeName, recursive).iterator();
}
- /** Gets parent element or null if there is none
+ /**
+ * Gets parent element or null if there is none
+ *
+ * @param node child
+ * @return element
*/
public static Element getParentElement(Node node)
{
@@ -557,7 +679,13 @@
return retElement;
}
- /** Parse the given XML string and return the root Element
+ /**
+ * Parse the given XML string and return the root Element
+ *
+ * @param xmlString string to be parsed
+ * @param builder document builder
+ * @return element
+ * @throws IOException exception
*/
public static Element parse(String xmlString, DocumentBuilder builder) throws
IOException
{
@@ -572,7 +700,13 @@
}
}
- /** Parse the given XML stream and return the root Element
+ /**
+ * Parse the given XML stream and return the root Element
+ *
+ * @param xmlStream input stream
+ * @param builder document builder
+ * @return element
+ * @throws IOException exception
*/
public static Element parse(InputStream xmlStream, DocumentBuilder builder) throws
IOException
{
@@ -595,7 +729,13 @@
}
}
- /** Parse the given input source and return the root Element
+ /**
+ * Parse the given input source and return the root Element
+ *
+ * @param source input source
+ * @param builder document builder
+ * @return element
+ * @throws IOException exception
*/
public static Element parse(InputSource source, DocumentBuilder builder) throws
IOException
{
@@ -627,7 +767,14 @@
}
}
- /** Create an Element for a given name, prefix and uri
+ /**
+ * Create an Element for a given name, prefix and uri
+ *
+ * @param localPart xml local part
+ * @param prefix xml prefix
+ * @param uri uri
+ * @param doc document
+ * @return element
*/
public static Element createElement(String localPart, String prefix, String uri,
Document doc)
{