From c28d4d90ea44f43c80424ea548ef3701078f3d60 Mon Sep 17 00:00:00 2001 From: Christian Wulf <chw@informatik.uni-kiel.de> Date: Mon, 3 Aug 2015 09:48:45 +0200 Subject: [PATCH] added headers; fixed javadoc issues --- .../java/teetime/framework/A0UnconnectedPort.java | 15 +++++++++++++++ .../framework/A1ThreadableStageCollector.java | 15 +++++++++++++++ .../framework/A2InvalidThreadAssignmentCheck.java | 15 +++++++++++++++ .../teetime/framework/A3PipeInstantiation.java | 15 +++++++++++++++ .../teetime/framework/A4StageAttributeSetter.java | 15 +++++++++++++++ .../java/teetime/framework/AbstractService.java | 15 +++++++++++++++ src/main/java/teetime/framework/Execution.java | 11 +---------- .../java/teetime/framework/ITraverserVisitor.java | 15 +++++++++++++++ .../java/teetime/framework/TeeTimeThread.java | 15 +++++++++++++++ .../java/teetime/framework/ThreadService.java | 15 +++++++++++++++ .../exceptionHandling/TerminateException.java | 7 +++---- .../framework/exceptionHandling/package-info.java | 15 +++++++++++++++ .../java/teetime/framework/test/package-info.java | 15 +++++++++++++++ .../java/teetime/framework/TerminationTest.java | 15 +++++++++++++++ 14 files changed, 184 insertions(+), 14 deletions(-) diff --git a/src/main/java/teetime/framework/A0UnconnectedPort.java b/src/main/java/teetime/framework/A0UnconnectedPort.java index 39206bef..c3fd19bd 100644 --- a/src/main/java/teetime/framework/A0UnconnectedPort.java +++ b/src/main/java/teetime/framework/A0UnconnectedPort.java @@ -1,3 +1,18 @@ +/** + * Copyright (C) 2015 Christian Wulf, Nelson Tavares de Sousa (http://christianwulf.github.io/teetime) + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ package teetime.framework; import org.slf4j.Logger; diff --git a/src/main/java/teetime/framework/A1ThreadableStageCollector.java b/src/main/java/teetime/framework/A1ThreadableStageCollector.java index 6d3205aa..29f639c1 100644 --- a/src/main/java/teetime/framework/A1ThreadableStageCollector.java +++ b/src/main/java/teetime/framework/A1ThreadableStageCollector.java @@ -1,3 +1,18 @@ +/** + * Copyright (C) 2015 Christian Wulf, Nelson Tavares de Sousa (http://christianwulf.github.io/teetime) + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ package teetime.framework; import java.util.HashSet; diff --git a/src/main/java/teetime/framework/A2InvalidThreadAssignmentCheck.java b/src/main/java/teetime/framework/A2InvalidThreadAssignmentCheck.java index 84624943..63dda410 100644 --- a/src/main/java/teetime/framework/A2InvalidThreadAssignmentCheck.java +++ b/src/main/java/teetime/framework/A2InvalidThreadAssignmentCheck.java @@ -1,3 +1,18 @@ +/** + * Copyright (C) 2015 Christian Wulf, Nelson Tavares de Sousa (http://christianwulf.github.io/teetime) + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ package teetime.framework; import java.util.Set; diff --git a/src/main/java/teetime/framework/A3PipeInstantiation.java b/src/main/java/teetime/framework/A3PipeInstantiation.java index 18250c23..9d6ca928 100644 --- a/src/main/java/teetime/framework/A3PipeInstantiation.java +++ b/src/main/java/teetime/framework/A3PipeInstantiation.java @@ -1,3 +1,18 @@ +/** + * Copyright (C) 2015 Christian Wulf, Nelson Tavares de Sousa (http://christianwulf.github.io/teetime) + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ package teetime.framework; import java.util.HashSet; diff --git a/src/main/java/teetime/framework/A4StageAttributeSetter.java b/src/main/java/teetime/framework/A4StageAttributeSetter.java index 60a3a54e..1e8ea4c0 100644 --- a/src/main/java/teetime/framework/A4StageAttributeSetter.java +++ b/src/main/java/teetime/framework/A4StageAttributeSetter.java @@ -1,3 +1,18 @@ +/** + * Copyright (C) 2015 Christian Wulf, Nelson Tavares de Sousa (http://christianwulf.github.io/teetime) + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ package teetime.framework; import java.util.Set; diff --git a/src/main/java/teetime/framework/AbstractService.java b/src/main/java/teetime/framework/AbstractService.java index de7a3844..058ad187 100644 --- a/src/main/java/teetime/framework/AbstractService.java +++ b/src/main/java/teetime/framework/AbstractService.java @@ -1,3 +1,18 @@ +/** + * Copyright (C) 2015 Christian Wulf, Nelson Tavares de Sousa (http://christianwulf.github.io/teetime) + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ package teetime.framework; /** diff --git a/src/main/java/teetime/framework/Execution.java b/src/main/java/teetime/framework/Execution.java index e6e60886..e801ab6b 100644 --- a/src/main/java/teetime/framework/Execution.java +++ b/src/main/java/teetime/framework/Execution.java @@ -17,9 +17,6 @@ package teetime.framework; import java.util.Set; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; - import teetime.framework.signal.ValidatingSignal; import teetime.framework.validation.AnalysisNotValidException; @@ -39,7 +36,7 @@ import teetime.framework.validation.AnalysisNotValidException; */ public final class Execution<T extends Configuration> { - private static final Logger LOGGER = LoggerFactory.getLogger(Execution.class); + // private static final Logger LOGGER = LoggerFactory.getLogger(Execution.class); private final T configuration; private final ConfigurationContext configurationContext; @@ -61,8 +58,6 @@ public final class Execution<T extends Configuration> { * to be used for the analysis * @param validationEnabled * whether or not the validation should be executed - * @param factory - * specific listener for the exception handling */ public Execution(final T configuration, final boolean validationEnabled) { this.configuration = configuration; @@ -97,10 +92,6 @@ public final class Execution<T extends Configuration> { * */ private final void init() { - // ExecutionInstantiation executionInstantiation = new ExecutionInstantiation(configurationContext); - // executionInstantiation.instantiatePipes(); - - // configurationContext.initializeContext(); configurationContext.initializeServices(); } diff --git a/src/main/java/teetime/framework/ITraverserVisitor.java b/src/main/java/teetime/framework/ITraverserVisitor.java index 9f2c078d..5cd376f0 100644 --- a/src/main/java/teetime/framework/ITraverserVisitor.java +++ b/src/main/java/teetime/framework/ITraverserVisitor.java @@ -1,3 +1,18 @@ +/** + * Copyright (C) 2015 Christian Wulf, Nelson Tavares de Sousa (http://christianwulf.github.io/teetime) + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ package teetime.framework; import teetime.framework.Traverser.VisitorBehavior; diff --git a/src/main/java/teetime/framework/TeeTimeThread.java b/src/main/java/teetime/framework/TeeTimeThread.java index 00e96fac..dc0d9399 100644 --- a/src/main/java/teetime/framework/TeeTimeThread.java +++ b/src/main/java/teetime/framework/TeeTimeThread.java @@ -1,3 +1,18 @@ +/** + * Copyright (C) 2015 Christian Wulf, Nelson Tavares de Sousa (http://christianwulf.github.io/teetime) + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ package teetime.framework; public class TeeTimeThread extends Thread { diff --git a/src/main/java/teetime/framework/ThreadService.java b/src/main/java/teetime/framework/ThreadService.java index 00b46972..5bdca382 100644 --- a/src/main/java/teetime/framework/ThreadService.java +++ b/src/main/java/teetime/framework/ThreadService.java @@ -1,3 +1,18 @@ +/** + * Copyright (C) 2015 Christian Wulf, Nelson Tavares de Sousa (http://christianwulf.github.io/teetime) + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ package teetime.framework; import java.util.ArrayList; diff --git a/src/main/java/teetime/framework/exceptionHandling/TerminateException.java b/src/main/java/teetime/framework/exceptionHandling/TerminateException.java index 62b050d2..a05e2674 100644 --- a/src/main/java/teetime/framework/exceptionHandling/TerminateException.java +++ b/src/main/java/teetime/framework/exceptionHandling/TerminateException.java @@ -18,9 +18,8 @@ package teetime.framework.exceptionHandling; import teetime.util.StacklessException; /** - * Represents an Exception, which is thrown by stages in case of they import teetime.framework.Stage; - * original exception, which was thrown, call {@link #getCause()}. {@link #getThrowingStage()} returns the stage, which has thrown the original exception. - * + * Represents an exception that is used to terminate the running thread. + * * @since 1.1 */ public class TerminateException extends StacklessException { @@ -34,6 +33,6 @@ public class TerminateException extends StacklessException { private TerminateException(final String string) { super(string); - }; + } } diff --git a/src/main/java/teetime/framework/exceptionHandling/package-info.java b/src/main/java/teetime/framework/exceptionHandling/package-info.java index 7e9009ee..faaff285 100644 --- a/src/main/java/teetime/framework/exceptionHandling/package-info.java +++ b/src/main/java/teetime/framework/exceptionHandling/package-info.java @@ -1,3 +1,18 @@ +/** + * Copyright (C) 2015 Christian Wulf, Nelson Tavares de Sousa (http://christianwulf.github.io/teetime) + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ package teetime.framework.exceptionHandling; /** * TODO: diff --git a/src/main/java/teetime/framework/test/package-info.java b/src/main/java/teetime/framework/test/package-info.java index 7a2a47a5..7065bd49 100644 --- a/src/main/java/teetime/framework/test/package-info.java +++ b/src/main/java/teetime/framework/test/package-info.java @@ -1,3 +1,18 @@ +/** + * Copyright (C) 2015 Christian Wulf, Nelson Tavares de Sousa (http://christianwulf.github.io/teetime) + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ package teetime.framework.test; /** * TODO: diff --git a/src/test/java/teetime/framework/TerminationTest.java b/src/test/java/teetime/framework/TerminationTest.java index 2c0bffe3..84bc5425 100644 --- a/src/test/java/teetime/framework/TerminationTest.java +++ b/src/test/java/teetime/framework/TerminationTest.java @@ -1,3 +1,18 @@ +/** + * Copyright (C) 2015 Christian Wulf, Nelson Tavares de Sousa (http://christianwulf.github.io/teetime) + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ package teetime.framework; import static org.hamcrest.Matchers.greaterThan; -- GitLab