By moving the definition of the base data-set to the class visitor factory it is correctly tied to its implementation.

This removes all complexities with defining a custom data-set/class visitor.

Author: Kiskae

src/main/java/nl/rug/jbi/jsm/bcel/ClassVisitor.java

@@ -1,6 +1,7 @@
 package nl.rug.jbi.jsm.bcel;
 
 import com.google.common.base.Preconditions;
+import com.google.common.collect.ImmutableSet;
 import nl.rug.jbi.jsm.core.event.EventBus;
 import org.apache.bcel.classfile.*;
 import org.apache.bcel.classfile.Deprecated;
@@ -21,8 +22,17 @@
  * @since 2014-05-28
  */
 public class ClassVisitor extends EmptyVisitor {
+    public final static ImmutableSet<Class> DEFAULT_CLASSES = ImmutableSet.<Class>builder()
+            .add(JavaClassDefinition.class)
+            .add(MethodDefinition.class)
+            .add(FieldDefinition.class)
+            .add(ExceptionHandlerDefinition.class)
+            .add(FieldAccessInstr.class)
+            .add(InvokeMethodInstr.class)
+            .add(TypeUseInstruction.class)
+            .add(LocalVariableDefinition.class)
+            .build();
     private final static Logger logger = LogManager.getLogger(ClassVisitor.class);
-
     private final JavaClass visitedClass;
     private final EventBus eBus;
     private final ConstantPoolGen cp;

src/main/java/nl/rug/jbi/jsm/core/JSMCore.java

@@ -1,5 +1,6 @@
 package nl.rug.jbi.jsm.core;
 
+import com.google.common.base.Preconditions;
 import nl.rug.jbi.jsm.bcel.CompositeBCELClassLoader;
 import nl.rug.jbi.jsm.core.calculator.BaseMetric;
 import nl.rug.jbi.jsm.core.calculator.MetricCollection;
@@ -25,7 +26,7 @@
  * @since 2014-06-01
  */
 public class JSMCore {
-    private final Pipeline pipe = new Pipeline();
+    private final Pipeline pipe;
     private final ClassVisitorFactory cvFactory;
     private volatile boolean running = false;
 
@@ -42,7 +43,10 @@ public JSMCore() {
      * @param cvFactory factory which produced the class visitors that are used during execution.
      */
     public JSMCore(final ClassVisitorFactory cvFactory) {
+        Preconditions.checkNotNull(cvFactory, "Factory cannot be NULL");
+
         this.cvFactory = cvFactory;
+        this.pipe = new Pipeline(this.cvFactory.getDefaultDataClasses());
     }
 
     /**

src/main/java/nl/rug/jbi/jsm/core/execution/ClassVisitorFactory.java

@@ -3,6 +3,8 @@
 import nl.rug.jbi.jsm.core.event.EventBus;
 import org.apache.bcel.classfile.JavaClass;
 
+import java.util.Set;
+
 /**
  * Factory for the ClassVisitor runnable, given the {@link org.apache.bcel.classfile.JavaClass} and the associated
  * EventBus, a class visitor needs to be created which extracts data from the JavaClass and publishes it through the
@@ -23,4 +25,12 @@ public interface ClassVisitorFactory {
      * @return Runnable that will execute the class visitor.
      */
     public Runnable createClassVisitor(final JavaClass targetClass, final EventBus eventBus);
+
+    /**
+     * If the {@link nl.rug.jbi.jsm.bcel.ClassVisitor} is extended, this should return a super-set of
+     * {@link nl.rug.jbi.jsm.bcel.ClassVisitor#DEFAULT_CLASSES}.
+     *
+     * @return The set of classes which get produced by the class visitors this factory creates.
+     */
+    public Set<Class> getDefaultDataClasses();
 }

src/main/java/nl/rug/jbi/jsm/core/execution/JSMClassVisitorFactory.java

@@ -4,6 +4,8 @@
 import nl.rug.jbi.jsm.core.event.EventBus;
 import org.apache.bcel.classfile.JavaClass;
 
+import java.util.Set;
+
 public class JSMClassVisitorFactory implements ClassVisitorFactory {
     public final static JSMClassVisitorFactory INSTANCE = new JSMClassVisitorFactory();
 
@@ -17,4 +19,9 @@ public void run() {
             }
         };
     }
+
+    @Override
+    public Set<Class> getDefaultDataClasses() {
+        return ClassVisitor.DEFAULT_CLASSES;
+    }
 }

src/main/java/nl/rug/jbi/jsm/core/pipeline/Pipeline.java

@@ -2,9 +2,12 @@
 
 import com.google.common.base.Function;
 import com.google.common.base.Objects;
+import com.google.common.base.Preconditions;
 import com.google.common.base.Predicate;
-import com.google.common.collect.*;
-import nl.rug.jbi.jsm.bcel.*;
+import com.google.common.collect.FluentIterable;
+import com.google.common.collect.Iterables;
+import com.google.common.collect.Lists;
+import com.google.common.collect.Maps;
 import nl.rug.jbi.jsm.core.calculator.*;
 import nl.rug.jbi.jsm.core.event.Subscribe;
 import nl.rug.jbi.jsm.core.event.UsingProducer;
@@ -15,7 +18,10 @@
 import java.lang.reflect.InvocationTargetException;
 import java.lang.reflect.Method;
 import java.lang.reflect.Modifier;
-import java.util.*;
+import java.util.Collections;
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
 
 import static com.google.common.base.Preconditions.checkArgument;
 import static com.google.common.base.Preconditions.checkNotNull;
@@ -31,36 +37,29 @@
 public class Pipeline {
     private final static Logger logger = LogManager.getLogger(Pipeline.class);
 
-    //This set contains all types of data that get produces for the first CLASS frame.
-    private final static Set<Class> BASE_DATA_CLASSES = Sets.newTreeSet(new Comparator<Class>() {
-        @Override
-        public int compare(Class o1, Class o2) {
-            return o1.getName().compareTo(o2.getName());
-        }
-    });
-
-    static {
-        //Register the basic types produced by the BCELClassVisitor
-        registerNewBaseData(JavaClassDefinition.class);
-        registerNewBaseData(MethodDefinition.class);
-        registerNewBaseData(FieldDefinition.class);
-        registerNewBaseData(ExceptionHandlerDefinition.class);
-        registerNewBaseData(FieldAccessInstr.class);
-        registerNewBaseData(InvokeMethodInstr.class);
-        registerNewBaseData(TypeUseInstruction.class);
-        registerNewBaseData(LocalVariableDefinition.class);
-    }
-
     private final Map<MetricScope, HandlerMap> handlerMaps = Maps.newEnumMap(MetricScope.class);
     private final Map<MetricScope, PipelineFrame> frameMap = Maps.newEnumMap(MetricScope.class);
     private final Map<Class<? extends ProducerMetric>, ProducerMetric> registeredProducers = Maps.newHashMap();
 
-    public Pipeline() {
+    /**
+     * Creates a new pipeline-frame execution plan.
+     *
+     * @param defaultDataClasses The set of data available in the first frame of the class scope.
+     */
+    public Pipeline(final Set<Class> defaultDataClasses) {
+        Preconditions.checkNotNull(defaultDataClasses, "The set of default data classes cannot be NULL.");
+        Preconditions.checkArgument(Iterables.all(defaultDataClasses, new Predicate<Class>() {
+            @Override
+            public boolean apply(Class aClass) {
+                return aClass != null;
+            }
+        }), "The set of default data classes cannot contain NULL.");
+
         this.handlerMaps.put(MetricScope.CLASS, new HandlerMap());
         this.handlerMaps.put(MetricScope.PACKAGE, new HandlerMap());
         this.handlerMaps.put(MetricScope.COLLECTION, new HandlerMap());
 
-        this.frameMap.put(MetricScope.CLASS, new PipelineFrame(MetricScope.CLASS, BASE_DATA_CLASSES));
+        this.frameMap.put(MetricScope.CLASS, new PipelineFrame(MetricScope.CLASS, defaultDataClasses));
         this.frameMap.put(MetricScope.PACKAGE, new PipelineFrame(MetricScope.PACKAGE));
         this.frameMap.put(MetricScope.COLLECTION, new PipelineFrame(MetricScope.COLLECTION));
     }
@@ -71,9 +70,11 @@ public Pipeline() {
      * class are created to prevent exceptions related to unknown data-types.
      *
      * @param dataType The data-type to register within the initial CLASS frame.
+     * @deprecated Definition moved to class visitor factory, since the set is tied to it.
      */
+    @Deprecated
     public static void registerNewBaseData(final Class dataType) {
-        Pipeline.BASE_DATA_CLASSES.add(dataType);
+        //NOOP
     }
 
     private Pair<Class, HandlerExecutor> processMethod(final Method listener, final BaseMetric metric)