Add Javadoc and related settings

[lttng-ust-java-tests.git] / src / test / java / org / lttng / ust / agent / benchmarks / jul / handler / JulHandlerBenchmarkBase.java

diff --git a/src/test/java/org/lttng/ust/agent/benchmarks/jul/handler/JulHandlerBenchmarkBase.java b/src/test/java/org/lttng/ust/agent/benchmarks/jul/handler/JulHandlerBenchmarkBase.java
index dbfd33177803feb6fefd8742f68d52f1f6af3e7d..9ac3df5075ec4937d3b5fc636875ba7f2889cddc 100644 (file)
--- a/src/test/java/org/lttng/ust/agent/benchmarks/jul/handler/JulHandlerBenchmarkBase.java
+++ b/src/test/java/org/lttng/ust/agent/benchmarks/jul/handler/JulHandlerBenchmarkBase.java
@@ -1,3 +1,21 @@
+/*
+ * Copyright (C) 2015, EfficiOS Inc., Alexandre Montplaisir <alexmonthy@efficios.com>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ */
+
 package org.lttng.ust.agent.benchmarks.jul.handler;
 
 import java.util.LinkedList;
@@ -10,6 +28,10 @@ import org.junit.After;
 import org.junit.Before;
 import org.junit.Test;
 
+/**
+ * Base abstract class for JUL benchmarks. Sub-classes can setup parameters to
+ * test different types of log handlers.
+ */
 public abstract class JulHandlerBenchmarkBase {
 
     // ------------------------------------------------------------------------
@@ -36,6 +58,9 @@ public abstract class JulHandlerBenchmarkBase {
     // Maintenance methods
     // ------------------------------------------------------------------------
 
+    /**
+     * Base test setup
+     */
     @Before
     public void setup() {
         /* Set up the logger */
@@ -46,6 +71,9 @@ public abstract class JulHandlerBenchmarkBase {
         /* Sub-classes' @Before will setup the Handler */
     }
 
+    /**
+     * Base test teardown
+     */
     @After
     public void teardown() {
         if (handler != null) {
@@ -60,6 +88,9 @@ public abstract class JulHandlerBenchmarkBase {
     // Test methods
     // ------------------------------------------------------------------------
 
+    /**
+     * Main test class for running the benchmark
+     */
     @Test
     public void runBenchmark() {
         if (handler != null) {