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/pipe/SingleElementPipe.java

@@ -3,7 +3,7 @@ package teetime.framework.pipe;
 import teetime.framework.InputPort;
 import teetime.framework.OutputPort;
 
-public final class SingleElementPipe extends IntraThreadPipe {
+public final class SingleElementPipe extends AbstractIntraThreadPipe {
 
 	private Object element;
 
@@ -13,7 +13,7 @@ public final class SingleElementPipe extends IntraThreadPipe {
 
 	@Deprecated
 	public static <T> void connect(final OutputPort<? extends T> sourcePort, final InputPort<T> targetPort) {
-		IPipe pipe = new SingleElementPipe(null, null);
+		final IPipe pipe = new SingleElementPipe(null, null);
 		pipe.connectPorts(sourcePort, targetPort);
 	}
 
@@ -25,7 +25,7 @@ public final class SingleElementPipe extends IntraThreadPipe {
 
 	@Override
 	public Object removeLast() {
-		Object temp = this.element;
+		final Object temp = this.element;
 		this.element = null;
 		return temp;
 	}

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

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

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

@@ -10,7 +10,7 @@ import org.jctools.queues.spec.Preference;
 import teetime.framework.InputPort;
 import teetime.framework.OutputPort;
 
-public final class SpScPipe extends InterThreadPipe {
+public final class SpScPipe extends AbstractInterThreadPipe {
 
 	private final Queue<Object> queue;
 	// statistics
@@ -23,7 +23,7 @@ public final class SpScPipe extends InterThreadPipe {
 
 	@Deprecated
 	public static <T> SpScPipe connect(final OutputPort<? extends T> sourcePort, final InputPort<T> targetPort, final int capacity) {
-		SpScPipe pipe = new SpScPipe(sourcePort, targetPort, capacity);
+		final SpScPipe pipe = new SpScPipe(sourcePort, targetPort, capacity);
 		pipe.connectPorts(sourcePort, targetPort);
 		return pipe;
 	}

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

@@ -7,9 +7,11 @@ import teetime.framework.pipe.PipeFactoryRegistry.ThreadCommunication;
 
 public class SpScPipeFactory implements IPipeFactory {
 
+	public SpScPipeFactory() {}
+
 	@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/UnorderedGrowablePipe.java

@@ -3,7 +3,7 @@ package teetime.framework.pipe;
 import teetime.framework.InputPort;
 import teetime.framework.OutputPort;
 
-public final class UnorderedGrowablePipe extends IntraThreadPipe {
+public final class UnorderedGrowablePipe extends AbstractIntraThreadPipe {
 
 	private Object[] elements;
 	// private final ArrayWrapper2<T> elements = new ArrayWrapper2<T>(2);
@@ -16,7 +16,7 @@ public final class UnorderedGrowablePipe extends IntraThreadPipe {
 
 	@Deprecated
 	public static <T> void connect(final OutputPort<? extends T> sourcePort, final InputPort<T> targetPort) {
-		IPipe pipe = new UnorderedGrowablePipe(null, null, 4);
+		final IPipe pipe = new UnorderedGrowablePipe(null, null, 4);
 		pipe.connectPorts(sourcePort, targetPort);
 	}
 
@@ -36,7 +36,7 @@ public final class UnorderedGrowablePipe extends IntraThreadPipe {
 		// if (this.lastFreeIndex == 0) {
 		// return null;
 		// }
-		Object element = this.elements[--this.lastFreeIndex];
+		final Object element = this.elements[--this.lastFreeIndex];
 		this.elements[this.lastFreeIndex] = null;
 		// T element = this.elements.get(--this.lastFreeIndex);
 		return element;
@@ -59,7 +59,7 @@ public final class UnorderedGrowablePipe extends IntraThreadPipe {
 	}
 
 	private Object[] grow() {
-		int newSize = this.elements.length * 2;
+		final int newSize = this.elements.length * 2;
 		// System.out.println("growing to " + newSize);
 		return this.newArray(newSize);
 	}
@@ -71,7 +71,7 @@ public final class UnorderedGrowablePipe extends IntraThreadPipe {
 	// }
 
 	private Object[] newArray(final int newSize) {
-		Object[] newElements = new Object[newSize];
+		final Object[] newElements = new Object[newSize];
 
 		System.arraycopy(this.elements, 0, newElements, 0, this.elements.length);
 

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

@@ -7,9 +7,11 @@ import teetime.framework.pipe.PipeFactoryRegistry.ThreadCommunication;
 
 public class UnorderedGrowablePipeFactory implements IPipeFactory {
 
+	public UnorderedGrowablePipeFactory() {}
+
 	@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/signal/StartingSignal.java

@@ -13,19 +13,21 @@ public class StartingSignal implements ISignal {
 	private static final Logger LOGGER = LoggerFactory.getLogger(StartingSignal.class);
 	private final List<Exception> catchedExceptions = new LinkedList<Exception>();
 
+	public StartingSignal() {}
+
 	@Override
 	public void trigger(final AbstractStage stage) {
 		try {
 			stage.onStarting();
 			LOGGER.info(stage + " started.");
-		} catch (Exception e) {
-			catchedExceptions.add(e);
+		} catch (Exception e) { // NOCS (Stages can throw any arbitrary Exception)
+			this.catchedExceptions.add(e);
 			LOGGER.error("Exception while sending the start signal", e);
 		}
 	}
 
 	public List<Exception> getCatchedExceptions() {
-		return catchedExceptions;
+		return this.catchedExceptions;
 	}
 
 }

src/main/java/teetime/framework/signal/TerminatingSignal.java

@@ -13,18 +13,20 @@ public class TerminatingSignal implements ISignal {
 	private static final Logger LOGGER = LoggerFactory.getLogger(TerminatingSignal.class);
 	private final List<Exception> catchedExceptions = new LinkedList<Exception>();
 
+	public TerminatingSignal() {}
+
 	@Override
 	public void trigger(final AbstractStage stage) {
 		try {
 			stage.onTerminating();
-		} catch (Exception e) {
-			catchedExceptions.add(e);
+		} catch (Exception e) { // NOCS (Stages can throw any arbitrary Exception)
+			this.catchedExceptions.add(e);
 			LOGGER.error("Exception while sending the termination signal", e);
 		}
 	}
 
 	public List<Exception> getCatchedExceptions() {
-		return catchedExceptions;
+		return this.catchedExceptions;
 	}
 
 }

src/main/java/teetime/framework/signal/ValidatingSignal.java

@@ -10,13 +10,15 @@ public class ValidatingSignal implements ISignal {
 
 	private final List<InvalidPortConnection> invalidPortConnections = new LinkedList<InvalidPortConnection>();
 
+	public ValidatingSignal() {}
+
 	@Override
 	public void trigger(final AbstractStage stage) {
 		stage.onValidating(this.invalidPortConnections);
 	}
 
 	public List<InvalidPortConnection> getInvalidPortConnections() {
-		return invalidPortConnections;
+		return this.invalidPortConnections;
 	}
 
 }

src/main/java/teetime/framework/validation/AnalysisNotValidException.java

@@ -18,7 +18,7 @@ public class AnalysisNotValidException extends RuntimeException {
 
 	@Override
 	public String getMessage() {
-		StringBuilder builder = new StringBuilder(this.invalidPortConnections.size() * 40);
+		final StringBuilder builder = new StringBuilder(this.invalidPortConnections.size() * 40);
 		builder.append(this.invalidPortConnections.size());
 		builder.append(" invalid port connections were detected.\n");
 		Joiner.on("\n").appendTo(builder, this.invalidPortConnections);

src/main/java/teetime/framework/validation/InvalidPortConnection.java

@@ -24,8 +24,8 @@ public class InvalidPortConnection {
 
 	@Override
 	public String toString() {
-		String sourcePortTypeName = (this.sourcePort.getType() == null) ? null : this.sourcePort.getType().getName();
-		String targetPortTypeName = (this.targetPort.getType() == null) ? null : this.targetPort.getType().getName();
+		final String sourcePortTypeName = (this.sourcePort.getType() == null) ? null : this.sourcePort.getType().getName();
+		final String targetPortTypeName = (this.targetPort.getType() == null) ? null : this.targetPort.getType().getName();
 		return sourcePortTypeName + " != " + targetPortTypeName;
 	}
 

src/main/java/teetime/stage/ByteArray2String.java

@@ -2,10 +2,10 @@ package teetime.stage;
 
 import java.nio.charset.Charset;
 
-import teetime.framework.ConsumerStage;
+import teetime.framework.AbstractConsumerStage;
 import teetime.framework.OutputPort;
 
-public class ByteArray2String extends ConsumerStage<byte[]> {
+public class ByteArray2String extends AbstractConsumerStage<byte[]> {
 
 	private final OutputPort<String> outputPort = this.createOutputPort();
 

src/main/java/teetime/stage/Cache.java

@@ -4,11 +4,11 @@ import java.util.LinkedList;
 import java.util.List;
 import java.util.concurrent.TimeUnit;
 
-import teetime.framework.ConsumerStage;
+import teetime.framework.AbstractConsumerStage;
 import teetime.framework.OutputPort;
 import teetime.util.StopWatch;
 
-public class Cache<T> extends ConsumerStage<T> {
+public class Cache<T> extends AbstractConsumerStage<T> {
 
 	private final OutputPort<T> outputPort = this.createOutputPort();
 

src/main/java/teetime/stage/CipherByteArray.java

@@ -12,10 +12,10 @@ import javax.crypto.SecretKeyFactory;
 import javax.crypto.spec.PBEKeySpec;
 import javax.crypto.spec.SecretKeySpec;
 
-import teetime.framework.ConsumerStage;
+import teetime.framework.AbstractConsumerStage;
 import teetime.framework.OutputPort;
 
-public class CipherByteArray extends ConsumerStage<byte[]> {
+public class CipherByteArray extends AbstractConsumerStage<byte[]> {
 
 	private final OutputPort<byte[]> outputPort = this.createOutputPort();
 	private Cipher cipher = null;

src/main/java/teetime/stage/Clock.java

 package teetime.stage;
 
-import teetime.framework.ProducerStage;
+import teetime.framework.AbstractProducerStage;
 import teetime.framework.TerminationStrategy;
 
-public class Clock extends ProducerStage<Long> {
+public class Clock extends AbstractProducerStage<Long> {
 
 	private boolean initialDelayExceeded = false;
 

src/main/java/teetime/stage/CollectorSink.java

@@ -17,14 +17,14 @@ package teetime.stage;
 
 import java.util.List;
 
-import teetime.framework.ConsumerStage;
+import teetime.framework.AbstractConsumerStage;
 
 /**
  * @author Christian Wulf
  *
  * @since 1.10
  */
-public class CollectorSink<T> extends ConsumerStage<T> {
+public class CollectorSink<T> extends AbstractConsumerStage<T> {
 
 	// private final InputPort<T> inputPort = this.createInputPort();
 	//

src/main/java/teetime/stage/Counter.java

 package teetime.stage;
 
-import teetime.framework.ConsumerStage;
+import teetime.framework.AbstractConsumerStage;
 import teetime.framework.OutputPort;
 
-public class Counter<T> extends ConsumerStage<T> {
+public class Counter<T> extends AbstractConsumerStage<T> {
 
 	private final OutputPort<T> outputPort = this.createOutputPort();
 

src/main/java/teetime/stage/ElementDelayMeasuringStage.java

@@ -3,11 +3,11 @@ package teetime.stage;
 import java.util.LinkedList;
 import java.util.List;
 
-import teetime.framework.ConsumerStage;
+import teetime.framework.AbstractConsumerStage;
 import teetime.framework.InputPort;
 import teetime.framework.OutputPort;
 
-public class ElementDelayMeasuringStage<T> extends ConsumerStage<T> {
+public class ElementDelayMeasuringStage<T> extends AbstractConsumerStage<T> {
 
 	private final InputPort<Long> triggerInputPort = this.createInputPort();
 	private final OutputPort<T> outputPort = this.createOutputPort();

src/main/java/teetime/stage/ElementThroughputMeasuringStage.java

@@ -4,11 +4,11 @@ import java.util.LinkedList;
 import java.util.List;
 import java.util.concurrent.TimeUnit;
 
-import teetime.framework.ConsumerStage;
+import teetime.framework.AbstractConsumerStage;
 import teetime.framework.InputPort;
 import teetime.framework.OutputPort;
 
-public class ElementThroughputMeasuringStage<T> extends ConsumerStage<T> {
+public class ElementThroughputMeasuringStage<T> extends AbstractConsumerStage<T> {
 
 	private final InputPort<Long> triggerInputPort = this.createInputPort();
 	private final OutputPort<T> outputPort = this.createOutputPort();

src/main/java/teetime/stage/FileExtensionSwitch.java

@@ -4,12 +4,12 @@ import java.io.File;
 import java.util.HashMap;
 import java.util.Map;
 
-import teetime.framework.ConsumerStage;
+import teetime.framework.AbstractConsumerStage;
 import teetime.framework.OutputPort;
 
 import com.google.common.io.Files;
 
-public class FileExtensionSwitch extends ConsumerStage<File> {
+public class FileExtensionSwitch extends AbstractConsumerStage<File> {
 
 	private final Map<String, OutputPort<File>> fileExtensions = new HashMap<String, OutputPort<File>>();