You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by mb...@apache.org on 2015/12/16 20:48:19 UTC
svn commit: r1720425 - in
/commons/proper/weaver/trunk/processor/src/main/java/org/apache/commons/weaver:
./ lifecycle/ spi/ utils/
Author: mbenson
Date: Wed Dec 16 19:48:18 2015
New Revision: 1720425
URL: http://svn.apache.org/viewvc?rev=1720425&view=rev
Log:
code quality
Modified:
commons/proper/weaver/trunk/processor/src/main/java/org/apache/commons/weaver/CleanProcessor.java
commons/proper/weaver/trunk/processor/src/main/java/org/apache/commons/weaver/Consumes.java
commons/proper/weaver/trunk/processor/src/main/java/org/apache/commons/weaver/Produces.java
commons/proper/weaver/trunk/processor/src/main/java/org/apache/commons/weaver/WeaveProcessor.java
commons/proper/weaver/trunk/processor/src/main/java/org/apache/commons/weaver/lifecycle/WeaveLifecycle.java
commons/proper/weaver/trunk/processor/src/main/java/org/apache/commons/weaver/lifecycle/WeaveLifecycleToken.java
commons/proper/weaver/trunk/processor/src/main/java/org/apache/commons/weaver/spi/Cleaner.java
commons/proper/weaver/trunk/processor/src/main/java/org/apache/commons/weaver/spi/WeaveLifecycleProvider.java
commons/proper/weaver/trunk/processor/src/main/java/org/apache/commons/weaver/spi/Weaver.java
commons/proper/weaver/trunk/processor/src/main/java/org/apache/commons/weaver/utils/Providers.java
Modified: commons/proper/weaver/trunk/processor/src/main/java/org/apache/commons/weaver/CleanProcessor.java
URL: http://svn.apache.org/viewvc/commons/proper/weaver/trunk/processor/src/main/java/org/apache/commons/weaver/CleanProcessor.java?rev=1720425&r1=1720424&r2=1720425&view=diff
==============================================================================
--- commons/proper/weaver/trunk/processor/src/main/java/org/apache/commons/weaver/CleanProcessor.java (original)
+++ commons/proper/weaver/trunk/processor/src/main/java/org/apache/commons/weaver/CleanProcessor.java Wed Dec 16 19:48:18 2015
@@ -27,7 +27,7 @@ import java.util.ServiceLoader;
import java.util.Set;
import java.util.logging.Logger;
-import org.apache.commons.weaver.lifecycle.WeaveLifecycle;
+import org.apache.commons.weaver.lifecycle.WeaveLifecycle; //NOPMD used in javadoc
import org.apache.commons.weaver.model.WeaveEnvironment;
import org.apache.commons.weaver.spi.Cleaner;
import org.apache.commons.weaver.utils.URLArray;
Modified: commons/proper/weaver/trunk/processor/src/main/java/org/apache/commons/weaver/Consumes.java
URL: http://svn.apache.org/viewvc/commons/proper/weaver/trunk/processor/src/main/java/org/apache/commons/weaver/Consumes.java?rev=1720425&r1=1720424&r2=1720425&view=diff
==============================================================================
--- commons/proper/weaver/trunk/processor/src/main/java/org/apache/commons/weaver/Consumes.java (original)
+++ commons/proper/weaver/trunk/processor/src/main/java/org/apache/commons/weaver/Consumes.java Wed Dec 16 19:48:18 2015
@@ -29,7 +29,7 @@ import org.apache.commons.weaver.spi.Wea
/**
* Mark a {@link WeaveLifecycleProvider} as consuming the output of additional
- * {@link WeaveLifecycleProvider}es of the same broad type.
+ * {@link WeaveLifecycleProvider}s for the same lifecycle stage.
*/
@Documented
@Retention(RetentionPolicy.RUNTIME)
@@ -38,7 +38,6 @@ import org.apache.commons.weaver.spi.Wea
public @interface Consumes {
/**
* The consumed types.
- * @return Class[]
*/
Class<? extends WeaveLifecycleProvider<?>>[] value();
}
Modified: commons/proper/weaver/trunk/processor/src/main/java/org/apache/commons/weaver/Produces.java
URL: http://svn.apache.org/viewvc/commons/proper/weaver/trunk/processor/src/main/java/org/apache/commons/weaver/Produces.java?rev=1720425&r1=1720424&r2=1720425&view=diff
==============================================================================
--- commons/proper/weaver/trunk/processor/src/main/java/org/apache/commons/weaver/Produces.java (original)
+++ commons/proper/weaver/trunk/processor/src/main/java/org/apache/commons/weaver/Produces.java Wed Dec 16 19:48:18 2015
@@ -29,7 +29,7 @@ import org.apache.commons.weaver.spi.Wea
/**
* Mark a {@link WeaveLifecycleProvider} as creating output that is consumed by additional
- * {@link WeaveLifecycleProvider}es of the same broad type.
+ * {@link WeaveLifecycleProvider}s for the same lifecycle stage.
*/
@Documented
@Retention(RetentionPolicy.RUNTIME)
@@ -38,7 +38,6 @@ import org.apache.commons.weaver.spi.Wea
public @interface Produces {
/**
* The consuming types.
- * @return Class[]
*/
Class<? extends WeaveLifecycleProvider<?>>[] value();
}
Modified: commons/proper/weaver/trunk/processor/src/main/java/org/apache/commons/weaver/WeaveProcessor.java
URL: http://svn.apache.org/viewvc/commons/proper/weaver/trunk/processor/src/main/java/org/apache/commons/weaver/WeaveProcessor.java?rev=1720425&r1=1720424&r2=1720425&view=diff
==============================================================================
--- commons/proper/weaver/trunk/processor/src/main/java/org/apache/commons/weaver/WeaveProcessor.java (original)
+++ commons/proper/weaver/trunk/processor/src/main/java/org/apache/commons/weaver/WeaveProcessor.java Wed Dec 16 19:48:18 2015
@@ -27,7 +27,7 @@ import java.util.ServiceLoader;
import java.util.Set;
import java.util.logging.Logger;
-import org.apache.commons.weaver.lifecycle.WeaveLifecycle;
+import org.apache.commons.weaver.lifecycle.WeaveLifecycle; //NOPMD used in javadoc
import org.apache.commons.weaver.model.WeaveEnvironment;
import org.apache.commons.weaver.spi.Weaver;
import org.apache.commons.weaver.utils.URLArray;
Modified: commons/proper/weaver/trunk/processor/src/main/java/org/apache/commons/weaver/lifecycle/WeaveLifecycle.java
URL: http://svn.apache.org/viewvc/commons/proper/weaver/trunk/processor/src/main/java/org/apache/commons/weaver/lifecycle/WeaveLifecycle.java?rev=1720425&r1=1720424&r2=1720425&view=diff
==============================================================================
--- commons/proper/weaver/trunk/processor/src/main/java/org/apache/commons/weaver/lifecycle/WeaveLifecycle.java (original)
+++ commons/proper/weaver/trunk/processor/src/main/java/org/apache/commons/weaver/lifecycle/WeaveLifecycle.java Wed Dec 16 19:48:18 2015
@@ -21,8 +21,17 @@ package org.apache.commons.weaver.lifecy
/**
* Defines the parts of the weave lifecycle.
+ *
* @since 1.2
*/
public enum WeaveLifecycle {
- CLEAN, WEAVE;
+ /**
+ * Depicts the 'clean' stage of the lifecycle.
+ */
+ CLEAN,
+
+ /**
+ * Depicts the 'weave' stage of the lifecycle.
+ */
+ WEAVE;
}
Modified: commons/proper/weaver/trunk/processor/src/main/java/org/apache/commons/weaver/lifecycle/WeaveLifecycleToken.java
URL: http://svn.apache.org/viewvc/commons/proper/weaver/trunk/processor/src/main/java/org/apache/commons/weaver/lifecycle/WeaveLifecycleToken.java?rev=1720425&r1=1720424&r2=1720425&view=diff
==============================================================================
--- commons/proper/weaver/trunk/processor/src/main/java/org/apache/commons/weaver/lifecycle/WeaveLifecycleToken.java (original)
+++ commons/proper/weaver/trunk/processor/src/main/java/org/apache/commons/weaver/lifecycle/WeaveLifecycleToken.java Wed Dec 16 19:48:18 2015
@@ -26,7 +26,7 @@ import java.lang.annotation.Target;
/**
* Defines token classes corresponding to the elements of the {@link WeaveLifecycle}.
- *
+ *
* @since 1.2
*/
public class WeaveLifecycleToken {
@@ -37,6 +37,9 @@ public class WeaveLifecycleToken {
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface Represents {
+ /**
+ * The {@link WeaveLifecycle} stage represented by the annotated {@link WeaveLifecycleToken} type.
+ */
WeaveLifecycle value();
}
Modified: commons/proper/weaver/trunk/processor/src/main/java/org/apache/commons/weaver/spi/Cleaner.java
URL: http://svn.apache.org/viewvc/commons/proper/weaver/trunk/processor/src/main/java/org/apache/commons/weaver/spi/Cleaner.java?rev=1720425&r1=1720424&r2=1720425&view=diff
==============================================================================
--- commons/proper/weaver/trunk/processor/src/main/java/org/apache/commons/weaver/spi/Cleaner.java (original)
+++ commons/proper/weaver/trunk/processor/src/main/java/org/apache/commons/weaver/spi/Cleaner.java Wed Dec 16 19:48:18 2015
@@ -30,7 +30,7 @@ import org.apache.commons.weaver.model.W
public interface Cleaner extends WeaveLifecycleProvider<Clean> {
/**
* Using the supplied {@link Scanner}, clean a {@link WeaveEnvironment}.
- *
+ *
* @param environment to use
* @param scanner to use
* @return whether any work was done.
Modified: commons/proper/weaver/trunk/processor/src/main/java/org/apache/commons/weaver/spi/WeaveLifecycleProvider.java
URL: http://svn.apache.org/viewvc/commons/proper/weaver/trunk/processor/src/main/java/org/apache/commons/weaver/spi/WeaveLifecycleProvider.java?rev=1720425&r1=1720424&r2=1720425&view=diff
==============================================================================
--- commons/proper/weaver/trunk/processor/src/main/java/org/apache/commons/weaver/spi/WeaveLifecycleProvider.java (original)
+++ commons/proper/weaver/trunk/processor/src/main/java/org/apache/commons/weaver/spi/WeaveLifecycleProvider.java Wed Dec 16 19:48:18 2015
@@ -18,10 +18,12 @@
*/
package org.apache.commons.weaver.spi;
+import org.apache.commons.weaver.lifecycle.WeaveLifecycle; //NOPMD used in javadoc
import org.apache.commons.weaver.lifecycle.WeaveLifecycleToken;
/**
* Marker interface for commons-weaver lifecycle providers.
+ * @param <S> indicates a stage of the {@link WeaveLifecycle}
* @since 1.2
*/
public interface WeaveLifecycleProvider<S extends WeaveLifecycleToken> {
Modified: commons/proper/weaver/trunk/processor/src/main/java/org/apache/commons/weaver/spi/Weaver.java
URL: http://svn.apache.org/viewvc/commons/proper/weaver/trunk/processor/src/main/java/org/apache/commons/weaver/spi/Weaver.java?rev=1720425&r1=1720424&r2=1720425&view=diff
==============================================================================
--- commons/proper/weaver/trunk/processor/src/main/java/org/apache/commons/weaver/spi/Weaver.java (original)
+++ commons/proper/weaver/trunk/processor/src/main/java/org/apache/commons/weaver/spi/Weaver.java Wed Dec 16 19:48:18 2015
@@ -30,7 +30,7 @@ import org.apache.commons.weaver.model.W
public interface Weaver extends WeaveLifecycleProvider<Weave> {
/**
* Using the supplied {@link Scanner}, process a {@link WeaveEnvironment}.
- *
+ *
* @param environment to use
* @param scanner to use
* @return whether any work was done.
Modified: commons/proper/weaver/trunk/processor/src/main/java/org/apache/commons/weaver/utils/Providers.java
URL: http://svn.apache.org/viewvc/commons/proper/weaver/trunk/processor/src/main/java/org/apache/commons/weaver/utils/Providers.java?rev=1720425&r1=1720424&r2=1720425&view=diff
==============================================================================
--- commons/proper/weaver/trunk/processor/src/main/java/org/apache/commons/weaver/utils/Providers.java (original)
+++ commons/proper/weaver/trunk/processor/src/main/java/org/apache/commons/weaver/utils/Providers.java Wed Dec 16 19:48:18 2015
@@ -46,7 +46,7 @@ public final class Providers {
private static class SortWorker<P extends WeaveLifecycleProvider<?>> {
/**
- * Implement {@link Providers#sort(Iterable)}
+ * Implement {@link Providers#sort(Iterable)}.
*
* @param providers to sort
* @return {@link Iterable} of {@code P}
@@ -61,7 +61,7 @@ public final class Providers {
final Map<Class<? extends P>, State> stateMap = new HashMap<Class<? extends P>, Providers.State>();
final Deque<Class<? extends P>> visiting = new ArrayDeque<Class<? extends P>>();
- for (Class<? extends P> type : dependencyMap.keySet()) {
+ for (final Class<? extends P> type : dependencyMap.keySet()) {
final State state = stateMap.get(type);
if (state == null) {
@@ -90,7 +90,7 @@ public final class Providers {
stateMap.put(root, State.VISITING);
visiting.push(root);
- for (Class<? extends P> dependency : dependencyMap.get(root)) {
+ for (final Class<? extends P> dependency : dependencyMap.get(root)) {
final State state = stateMap.get(dependency);
if (state == State.VISITED) {
continue;
@@ -163,12 +163,12 @@ public final class Providers {
}
});
- for (WeaveLifecycleProvider<?> provider : providers) {
+ for (final WeaveLifecycleProvider<?> provider : providers) {
@SuppressWarnings("unchecked")
final Class<? extends P> type = (Class<? extends P>) provider.getClass();
Collections.addAll(result.get(type), consumedBy(type));
- for (Class<? extends P> dependent : producedBy(type)) {
+ for (final Class<? extends P> dependent : producedBy(type)) {
result.get(dependent).add(type);
}
}
@@ -186,8 +186,8 @@ public final class Providers {
final Set<P> result = new LinkedHashSet<P>();
- for (Class<? extends P> type : order) {
- for (P provider : providers) {
+ for (final Class<? extends P> type : order) {
+ for (final P provider : providers) {
if (type.isInstance(provider)) {
result.add(provider);
}
@@ -204,9 +204,7 @@ public final class Providers {
/**
* Sort the specified providers with respect to declared {@link Consumes} and {@link Produces} annotations.
*
- * @param
- * <P>
- * the {@link WeaveLifecycleProvider} type
+ * @param <P> the {@link WeaveLifecycleProvider} type
* @param providers to sort
* @return {@link Iterable} of {@code P}
*/