Author: davidb
Date: Fri Jun 1 12:32:20 2018
New Revision: 1832680
URL: http://svn.apache.org/viewvc?rev=1832680&view=rev
Log:
Fix up javadoc in preparation for release.
Modified:
aries/trunk/spi-fly/spi-fly-core/src/main/java/org/apache/aries/spifly/ConsumerHeaderProcessor.java
aries/trunk/spi-fly/spi-fly-core/src/main/java/org/apache/aries/spifly/WeavingData.java
Modified:
aries/trunk/spi-fly/spi-fly-core/src/main/java/org/apache/aries/spifly/ConsumerHeaderProcessor.java
URL:
http://svn.apache.org/viewvc/aries/trunk/spi-fly/spi-fly-core/src/main/java/org/apache/aries/spifly/ConsumerHeaderProcessor.java?rev=1832680&r1=1832679&r2=1832680&view=diff
==============================================================================
---
aries/trunk/spi-fly/spi-fly-core/src/main/java/org/apache/aries/spifly/ConsumerHeaderProcessor.java
(original)
+++
aries/trunk/spi-fly/spi-fly-core/src/main/java/org/apache/aries/spifly/ConsumerHeaderProcessor.java
Fri Jun 1 12:32:20 2018
@@ -18,6 +18,14 @@
*/
package org.apache.aries.spifly;
+import org.apache.aries.spifly.HeaderParser.PathElement;
+import org.apache.aries.util.manifest.ManifestHeaderProcessor;
+import org.apache.aries.util.manifest.ManifestHeaderProcessor.GenericMetadata;
+import org.osgi.framework.Filter;
+import org.osgi.framework.FrameworkUtil;
+import org.osgi.framework.InvalidSyntaxException;
+import org.osgi.framework.Version;
+
import java.util.ArrayList;
import java.util.Collection;
import java.util.Dictionary;
@@ -27,14 +35,6 @@ import java.util.List;
import java.util.ServiceLoader;
import java.util.Set;
-import org.apache.aries.spifly.HeaderParser.PathElement;
-import org.apache.aries.util.manifest.ManifestHeaderProcessor;
-import org.apache.aries.util.manifest.ManifestHeaderProcessor.GenericMetadata;
-import org.osgi.framework.Filter;
-import org.osgi.framework.FrameworkUtil;
-import org.osgi.framework.InvalidSyntaxException;
-import org.osgi.framework.Version;
-
public class ConsumerHeaderProcessor {
private static final Dictionary<String, String> PROCESSOR_FILTER_MATCH;
@@ -55,7 +55,7 @@ public class ConsumerHeaderProcessor {
* <li><b>true</b> - equivalent to
<tt>java.util.ServiceLoader#load(java.lang.Class)</tt>
* </ul>
* Additionally, it registers the consumer's constraints with the consumer
registry in the activator, if the
- * consumer is only constrained to a certain set of bundles.<p/>
+ * consumer is only constrained to a certain set of bundles.<p>
*
* The following attributes are supported:
* <ul>
@@ -70,6 +70,7 @@ public class ConsumerHeaderProcessor {
* @param consumerHeaderName the name of the header (either
Require-Capability or SPI-Consumer)
* @param consumerHeader the <tt>SPI-Consumer</tt> header.
* @return an instance of the {@link WeavingData} class.
+ * @throws Exception when a header cannot be parsed.
*/
public static Set<WeavingData> processHeader(String consumerHeaderName,
String consumerHeader) throws Exception {
if (SpiFlyConstants.REQUIRE_CAPABILITY.equals(consumerHeaderName)) {
Modified:
aries/trunk/spi-fly/spi-fly-core/src/main/java/org/apache/aries/spifly/WeavingData.java
URL:
http://svn.apache.org/viewvc/aries/trunk/spi-fly/spi-fly-core/src/main/java/org/apache/aries/spifly/WeavingData.java?rev=1832680&r1=1832679&r2=1832680&view=diff
==============================================================================
---
aries/trunk/spi-fly/spi-fly-core/src/main/java/org/apache/aries/spifly/WeavingData.java
(original)
+++
aries/trunk/spi-fly/spi-fly-core/src/main/java/org/apache/aries/spifly/WeavingData.java
Fri Jun 1 12:32:20 2018
@@ -38,8 +38,8 @@ public class WeavingData {
* @param argClasses The overload (class names of the signature) of the
call
* that needs to be woven. If <code>null</code> then all overloads of the
method
* need to be woven.
- * @param argRestrictions
- * @param allowedBundles
+ * @param argRestrictions A set of Consumer Restrictions.
+ * @param allowedBundles The list of allowed bundles.
*/
public WeavingData(String className, String methodName, String[]
argClasses, Set<ConsumerRestriction> argRestrictions, List<BundleDescriptor>
allowedBundles) {
// TODO can we infer argClasses from restrictions?
