Merge branch 'checkstyle-solved' into 'master'

Checkstyle solved

Solved a whole bunch of issues regarding checkstyle. For e.g. renamed interfaces to match I[A-Z0-9].* and abstract classes to match Abstract[A-Z0-9].*

See merge request !16

src/main/java/teetime/framework/ConsumerStage.java → src/main/java/teetime/framework/AbstractConsumerStage.java

 package teetime.framework;
 
-public abstract class ConsumerStage<I> extends AbstractStage {
+public abstract class AbstractConsumerStage<I> extends AbstractStage {
 
 	protected final InputPort<I> inputPort = this.createInputPort();
 
@@ -10,7 +10,7 @@ public abstract class ConsumerStage<I> extends AbstractStage {
 
 	@Override
 	public void executeWithPorts() {
-		I element = this.getInputPort().receive();
+		final I element = this.getInputPort().receive();
 
 		this.execute(element);
 	}

src/main/java/teetime/framework/ProducerStage.java → src/main/java/teetime/framework/AbstractProducerStage.java

@@ -9,7 +9,7 @@ package teetime.framework;
  *            the type of the default output port
  *
  */
-public abstract class ProducerStage<O> extends AbstractStage implements Stage {
+public abstract class AbstractProducerStage<O> extends AbstractStage implements IStage {
 
 	protected final OutputPort<O> outputPort = this.createOutputPort();
 

src/main/java/teetime/framework/AbstractStage.java

@@ -14,7 +14,7 @@ import teetime.framework.pipe.IPipe;
 import teetime.framework.signal.ISignal;
 import teetime.framework.validation.InvalidPortConnection;
 
-public abstract class AbstractStage implements Stage {
+public abstract class AbstractStage implements IStage {
 
 	private final String id;
 	/**
@@ -22,7 +22,7 @@ public abstract class AbstractStage implements Stage {
 	 */
 	protected final Logger logger; // NOPMD
 
-	private Stage parentStage;
+	private IStage parentStage;
 
 	private final List<InputPort<?>> inputPortList = new ArrayList<InputPort<?>>();
 	private final List<OutputPort<?>> outputPortList = new ArrayList<OutputPort<?>>();
@@ -75,12 +75,12 @@ public abstract class AbstractStage implements Stage {
 	}
 
 	@Override
-	public Stage getParentStage() {
+	public IStage getParentStage() {
 		return this.parentStage;
 	}
 
 	@Override
-	public void setParentStage(final Stage parentStage, final int index) {
+	public void setParentStage(final IStage parentStage, final int index) {
 		this.parentStage = parentStage;
 	}
 
@@ -126,18 +126,18 @@ public abstract class AbstractStage implements Stage {
 	}
 
 	public void onTerminating() throws Exception {
-		terminate();
+		this.terminate();
 	}
 
 	protected <T> InputPort<T> createInputPort() {
-		InputPort<T> inputPort = new InputPort<T>(this);
+		final InputPort<T> inputPort = new InputPort<T>(this);
 		// inputPort.setType(portType);
 		this.inputPortList.add(inputPort);
 		return inputPort;
 	}
 
 	protected <T> OutputPort<T> createOutputPort() {
-		OutputPort<T> outputPort = new OutputPort<T>();
+		final OutputPort<T> outputPort = new OutputPort<T>();
 		// outputPort.setType(portType);
 		this.outputPortList.add(outputPort);
 		return outputPort;
@@ -146,12 +146,12 @@ public abstract class AbstractStage implements Stage {
 	@Override
 	public void validateOutputPorts(final List<InvalidPortConnection> invalidPortConnections) {
 		for (OutputPort<?> outputPort : this.getOutputPorts()) {
-			IPipe pipe = outputPort.getPipe();
+			final IPipe pipe = outputPort.getPipe();
 			if (null != pipe) { // if output port is connected with another one
-				Class<?> sourcePortType = outputPort.getType();
-				Class<?> targetPortType = pipe.getTargetPort().getType();
+				final Class<?> sourcePortType = outputPort.getType();
+				final Class<?> targetPortType = pipe.getTargetPort().getType();
 				if (null == sourcePortType || !sourcePortType.equals(targetPortType)) {
-					InvalidPortConnection invalidPortConnection = new InvalidPortConnection(outputPort, pipe.getTargetPort());
+					final InvalidPortConnection invalidPortConnection = new InvalidPortConnection(outputPort, pipe.getTargetPort());
 					invalidPortConnections.add(invalidPortConnection);
 				}
 			}

src/main/java/teetime/framework/Analysis.java

@@ -28,9 +28,9 @@ public class Analysis implements UncaughtExceptionHandler {
 	}
 
 	public void init() {
-		List<Stage> threadableStageJobs = this.configuration.getThreadableStageJobs();
-		for (Stage stage : threadableStageJobs) {
-			Thread thread = new Thread(new RunnableStage(stage));
+		final List<IStage> threadableStageJobs = this.configuration.getThreadableStageJobs();
+		for (IStage stage : threadableStageJobs) {
+			final Thread thread = new Thread(new RunnableStage(stage));
 			switch (stage.getTerminationStrategy()) {
 			case BY_SIGNAL:
 				this.consumerThreads.add(thread);
@@ -41,6 +41,8 @@ public class Analysis implements UncaughtExceptionHandler {
 			case BY_INTERRUPT:
 				this.infiniteProducerThreads.add(thread);
 				break;
+			default:
+				break;
 			}
 		}
 

src/main/java/teetime/framework/AnalysisConfiguration.java

@@ -8,15 +8,16 @@ import teetime.framework.pipe.PipeFactoryRegistry;
 public class AnalysisConfiguration {
 
 	protected static final PipeFactoryRegistry PIPE_FACTORY_REGISTRY = PipeFactoryRegistry.INSTANCE;
+	private final List<IStage> threadableStageJobs = new LinkedList<IStage>();
 
-	private final List<Stage> threadableStageJobs = new LinkedList<Stage>();
+	public AnalysisConfiguration() {}
 
-	List<Stage> getThreadableStageJobs() {
-		return threadableStageJobs;
+	List<IStage> getThreadableStageJobs() {
+		return this.threadableStageJobs;
 	}
 
-	public void addThreadableStage(final Stage stage) {
-		threadableStageJobs.add(stage);
+	public void addThreadableStage(final IStage stage) {
+		this.threadableStageJobs.add(stage);
 	}
 
 }

src/main/java/teetime/framework/Stage.java → src/main/java/teetime/framework/IStage.java

@@ -5,15 +5,15 @@ import java.util.List;
 import teetime.framework.signal.ISignal;
 import teetime.framework.validation.InvalidPortConnection;
 
-public interface Stage extends Terminable {
+public interface IStage extends ITerminable {
 
 	String getId();
 
 	void executeWithPorts();
 
-	Stage getParentStage();
+	IStage getParentStage();
 
-	void setParentStage(Stage parentStage, int index);
+	void setParentStage(IStage parentStage, int index);
 
 	void onSignal(ISignal signal, InputPort<?> inputPort);
 

src/main/java/teetime/framework/Terminable.java → src/main/java/teetime/framework/ITerminable.java

 package teetime.framework;
 
-interface Terminable {
+interface ITerminable {
 
 	TerminationStrategy getTerminationStrategy();
 

src/main/java/teetime/framework/InputPort.java

@@ -4,22 +4,22 @@ import teetime.framework.pipe.IPipe;
 
 public class InputPort<T> extends AbstractPort<T> {
 
-	private final Stage owningStage;
+	private final IStage owningStage;
 
-	InputPort(final Stage owningStage) {
+	InputPort(final IStage owningStage) {
 		super();
 		this.owningStage = owningStage;
 	}
 
 	public T receive() {
 		@SuppressWarnings("unchecked")
-		T element = (T) this.pipe.removeLast();
+		final T element = (T) this.pipe.removeLast();
 		return element;
 	}
 
 	public T read() {
 		@SuppressWarnings("unchecked")
-		T element = (T) this.pipe.readLast();
+		final T element = (T) this.pipe.readLast();
 		return element;
 	}
 
@@ -33,7 +33,7 @@ public class InputPort<T> extends AbstractPort<T> {
 		this.pipe = pipe;
 	}
 
-	public Stage getOwningStage() {
+	public IStage getOwningStage() {
 		return this.owningStage;
 	}
 

src/main/java/teetime/framework/RunnableStage.java

@@ -11,11 +11,11 @@ import teetime.framework.validation.AnalysisNotValidException;
 @SuppressWarnings("PMD.BeanMembersShouldSerialize")
 public class RunnableStage implements Runnable {
 
-	private final Stage stage;
+	private final IStage stage;
 	private final Logger logger; // NOPMD
 	private boolean validationEnabled;
 
-	public RunnableStage(final Stage stage) {
+	public RunnableStage(final IStage stage) {
 		this.stage = stage;
 		this.logger = LoggerFactory.getLogger(stage.getClass());
 	}
@@ -25,7 +25,7 @@ public class RunnableStage implements Runnable {
 		this.logger.debug("Executing runnable stage...");
 
 		if (this.validationEnabled) {
-			ValidatingSignal validatingSignal = new ValidatingSignal();
+			final ValidatingSignal validatingSignal = new ValidatingSignal();
 			this.stage.onSignal(validatingSignal, null);
 			if (validatingSignal.getInvalidPortConnections().size() > 0) {
 				throw new AnalysisNotValidException(validatingSignal.getInvalidPortConnections());
@@ -33,23 +33,23 @@ public class RunnableStage implements Runnable {
 		}
 
 		try {
-			StartingSignal startingSignal = new StartingSignal();
+			final StartingSignal startingSignal = new StartingSignal();
 			this.stage.onSignal(startingSignal, null);
 
 			do {
 				this.stage.executeWithPorts();
 			} while (!this.stage.shouldBeTerminated());
 
-			TerminatingSignal terminatingSignal = new TerminatingSignal();
+			final TerminatingSignal terminatingSignal = new TerminatingSignal();
 			this.stage.onSignal(terminatingSignal, null);
 
 		} catch (Error e) {
 			this.logger.error("Terminating thread due to the following exception: ", e);
 			throw e;
-		} catch (RuntimeException e) {
-			this.logger.error("Terminating thread due to the following exception: ", e);
-			throw e;
-		}
+		} // catch (RuntimeException e) {
+		// this.logger.error("Terminating thread due to the following exception: ", e);
+		// throw e;
+		// }
 
 		this.logger.debug("Finished runnable stage. (" + this.stage.getId() + ")");
 	}

src/main/java/teetime/framework/pipe/InterThreadPipe.java → src/main/java/teetime/framework/pipe/AbstractInterThreadPipe.java

@@ -11,11 +11,11 @@ import teetime.framework.InputPort;
 import teetime.framework.OutputPort;
 import teetime.framework.signal.ISignal;
 
-public abstract class InterThreadPipe extends AbstractPipe {
+public abstract class AbstractInterThreadPipe extends AbstractPipe {
 
 	private final Queue<ISignal> signalQueue = QueueFactory.newQueue(new ConcurrentQueueSpec(1, 1, 0, Ordering.FIFO, Preference.THROUGHPUT));
 
-	<T> InterThreadPipe(final OutputPort<? extends T> sourcePort, final InputPort<T> targetPort) {
+	<T> AbstractInterThreadPipe(final OutputPort<? extends T> sourcePort, final InputPort<T> targetPort) {
 		super(sourcePort, targetPort);
 	}
 

src/main/java/teetime/framework/pipe/IntraThreadPipe.java → src/main/java/teetime/framework/pipe/AbstractIntraThreadPipe.java

@@ -4,9 +4,10 @@ import teetime.framework.InputPort;
 import teetime.framework.OutputPort;
 import teetime.framework.signal.ISignal;
 
-public abstract class IntraThreadPipe extends AbstractPipe {
+public abstract class AbstractIntraThreadPipe extends AbstractPipe {
 
-	<T> IntraThreadPipe(final OutputPort<? extends T> sourcePort, final InputPort<T> targetPort) {
+
+	<T> AbstractIntraThreadPipe(final OutputPort<? extends T> sourcePort, final InputPort<T> targetPort) {
 		super(sourcePort, targetPort);
 	}
 

src/main/java/teetime/framework/pipe/AbstractPipe.java

 package teetime.framework.pipe;
 
+import teetime.framework.IStage;
 import teetime.framework.InputPort;
 import teetime.framework.OutputPort;
-import teetime.framework.Stage;
 
 public abstract class AbstractPipe implements IPipe {
 
-	private InputPort<?> targetPort;
-
 	/**
 	 * Performance cache: Avoids the following method chain
 	 *
@@ -15,7 +13,9 @@ public abstract class AbstractPipe implements IPipe {
 	 * this.getPipe().getTargetPort().getOwningStage()
 	 * </pre>
 	 */
-	protected Stage cachedTargetStage;
+	protected IStage cachedTargetStage;
+
+	private InputPort<?> targetPort;
 
 	protected <T> AbstractPipe(final OutputPort<? extends T> sourcePort, final InputPort<T> targetPort) {
 		this.targetPort = targetPort;

src/main/java/teetime/framework/pipe/CommittablePipe.java

@@ -4,7 +4,7 @@ import teetime.framework.InputPort;
 import teetime.framework.OutputPort;
 import teetime.util.list.CommittableResizableArrayQueue;
 
-public final class CommittablePipe extends IntraThreadPipe {
+public final class CommittablePipe extends AbstractIntraThreadPipe {
 
 	private final CommittableResizableArrayQueue<Object> elements = new CommittableResizableArrayQueue<Object>(null, 4);
 
@@ -14,7 +14,7 @@ public final class CommittablePipe extends IntraThreadPipe {
 
 	@Deprecated
 	public static <T> void connect(final OutputPort<? extends T> sourcePort, final InputPort<T> targetPort) {
-		IPipe pipe = new CommittablePipe(null, null);
+		final IPipe pipe = new CommittablePipe(null, null);
 		pipe.connectPorts(sourcePort, targetPort);
 	}
 
@@ -37,7 +37,7 @@ public final class CommittablePipe extends IntraThreadPipe {
 	 */
 	@Override
 	public Object removeLast() {
-		Object element = this.elements.removeFromHeadUncommitted();
+		final Object element = this.elements.removeFromHeadUncommitted();
 		this.elements.commit();
 		return element;
 	}

src/main/java/teetime/framework/pipe/DummyPipe.java

@@ -13,6 +13,8 @@ import teetime.framework.signal.ISignal;
 @SuppressWarnings("rawtypes")
 public final class DummyPipe implements IPipe {
 
+	public DummyPipe() {}
+
 	@Override
 	public boolean add(final Object element) {
 		return false;

src/main/java/teetime/framework/pipe/OrderedGrowableArrayPipe.java

@@ -4,7 +4,7 @@ import teetime.framework.InputPort;
 import teetime.framework.OutputPort;
 import teetime.util.concurrent.workstealing.CircularArray;
 
-public final class OrderedGrowableArrayPipe extends IntraThreadPipe {
+public final class OrderedGrowableArrayPipe extends AbstractIntraThreadPipe {
 
 	private final CircularArray<Object> elements;
 	private int head;
@@ -17,7 +17,7 @@ public final class OrderedGrowableArrayPipe extends IntraThreadPipe {
 
 	@Deprecated
 	public static <T> void connect(final OutputPort<? extends T> sourcePort, final InputPort<T> targetPort) {
-		IPipe pipe = new OrderedGrowableArrayPipe(sourcePort, targetPort, 4);
+		final IPipe pipe = new OrderedGrowableArrayPipe(sourcePort, targetPort, 4);
 		pipe.connectPorts(sourcePort, targetPort);
 	}
 

src/main/java/teetime/framework/pipe/OrderedGrowableArrayPipeFactory.java

@@ -7,9 +7,11 @@ import teetime.framework.pipe.PipeFactoryRegistry.ThreadCommunication;
 
 public class OrderedGrowableArrayPipeFactory implements IPipeFactory {
 
+	public OrderedGrowableArrayPipeFactory() {}
+
 	@Override
 	public <T> IPipe create(final OutputPort<? extends T> sourcePort, final InputPort<T> targetPort) {
-		return create(sourcePort, targetPort, 4);
+		return this.create(sourcePort, targetPort, 4);
 	}
 
 	@Override

src/main/java/teetime/framework/pipe/OrderedGrowablePipe.java

@@ -5,7 +5,7 @@ import java.util.LinkedList;
 import teetime.framework.InputPort;
 import teetime.framework.OutputPort;
 
-public class OrderedGrowablePipe extends IntraThreadPipe {
+public class OrderedGrowablePipe extends AbstractIntraThreadPipe {
 
 	private final LinkedList<Object> elements;
 
@@ -16,7 +16,7 @@ public class OrderedGrowablePipe extends IntraThreadPipe {
 
 	@Deprecated
 	public static <T> void connect(final OutputPort<? extends T> sourcePort, final InputPort<T> targetPort) {
-		IPipe pipe = new OrderedGrowablePipe(null, null, 100000);
+		final IPipe pipe = new OrderedGrowablePipe(null, null, 100000);
 		pipe.connectPorts(sourcePort, targetPort);
 	}
 

src/main/java/teetime/framework/pipe/PipeFactoryLoader.java

@@ -23,18 +23,18 @@ public final class PipeFactoryLoader {
 	}
 
 	public static List<IPipeFactory> loadFromStream(final InputStream stream) throws IOException {
-		List<IPipeFactory> pipeFactories = new LinkedList<IPipeFactory>();
+		final List<IPipeFactory> pipeFactories = new LinkedList<IPipeFactory>();
 
-		BufferedReader bufferedReader = new BufferedReader(new InputStreamReader(stream, "UTF-8"));
+		final BufferedReader bufferedReader = new BufferedReader(new InputStreamReader(stream, "UTF-8"));
 		try {
 			String line;
 			while (null != (line = bufferedReader.readLine())) {
 				try {
 					line = line.trim();
 					if (!line.isEmpty()) {
-						Class<?> clazz = Class.forName(line);
-						Class<? extends IPipeFactory> pipeFactoryClass = clazz.asSubclass(IPipeFactory.class);
-						IPipeFactory pipeFactory = pipeFactoryClass.newInstance();
+						final Class<?> clazz = Class.forName(line);
+						final Class<? extends IPipeFactory> pipeFactoryClass = clazz.asSubclass(IPipeFactory.class);
+						final IPipeFactory pipeFactory = pipeFactoryClass.newInstance();
 						pipeFactories.add(pipeFactory);
 					}
 				} catch (ClassNotFoundException e) {
@@ -65,10 +65,10 @@ public final class PipeFactoryLoader {
 	}
 
 	public static List<IPipeFactory> mergeFiles(final List<URL> files) {
-		ArrayList<IPipeFactory> list = new ArrayList<IPipeFactory>();
+		final List<IPipeFactory> list = new ArrayList<IPipeFactory>();
 		for (URL url : files) {
 			try {
-				InputStream is = url.openStream();
+				final InputStream is = url.openStream();
 				list.addAll(loadFromStream(is));
 				is.close();
 			} catch (IOException e) {

src/main/java/teetime/framework/pipe/PipeFactoryRegistry.java

@@ -48,7 +48,7 @@ public final class PipeFactoryRegistry {
 	public static final PipeFactoryRegistry INSTANCE = new PipeFactoryRegistry("pipe-factories.conf");
 
 	private PipeFactoryRegistry(final String configFileName) {
-		List<IPipeFactory> pipeFactories = PipeFactoryLoader.loadPipeFactoriesFromClasspath(configFileName);
+		final List<IPipeFactory> pipeFactories = PipeFactoryLoader.loadPipeFactoriesFromClasspath(configFileName);
 		for (IPipeFactory pipeFactory : pipeFactories) {
 			this.register(pipeFactory);
 		}
@@ -67,8 +67,8 @@ public final class PipeFactoryRegistry {
 	 *         A PipeFactory, which provides suitable pipes.
 	 */
 	public IPipeFactory getPipeFactory(final ThreadCommunication tc, final PipeOrdering ordering, final boolean growable) {
-		String key = this.buildKey(tc, ordering, growable);
-		IPipeFactory pipeFactory = this.pipeFactories.get(key);
+		final String key = this.buildKey(tc, ordering, growable);
+		final IPipeFactory pipeFactory = this.pipeFactories.get(key);
 		if (null == pipeFactory) {
 			throw new CouldNotFindPipeImplException(key);
 		}
@@ -84,7 +84,7 @@ public final class PipeFactoryRegistry {
 	 *            A PipeFactory which will be added to the registry
 	 */
 	public void register(final IPipeFactory pipeFactory) {
-		String key = this.buildKey(pipeFactory.getThreadCommunication(), pipeFactory.getOrdering(), pipeFactory.isGrowable());
+		final String key = this.buildKey(pipeFactory.getThreadCommunication(), pipeFactory.getOrdering(), pipeFactory.isGrowable());
 		this.pipeFactories.put(key, pipeFactory);
 		LOGGER.info("Registered pipe factory: " + pipeFactory.getClass().getCanonicalName());
 	}

src/main/java/teetime/framework/pipe/RelayTestPipe.java

@@ -2,7 +2,7 @@ package teetime.framework.pipe;
 
 import teetime.util.ConstructorClosure;
 
-public final class RelayTestPipe<T> extends InterThreadPipe {
+public final class RelayTestPipe<T> extends AbstractInterThreadPipe {
 
 	private int numInputObjects;
 	private final ConstructorClosure<T> inputObjectCreator;