Add Javadoc and related settings

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

diff --git a/src/test/java/org/lttng/ust/agent/benchmarks/jul/handler/builtin/FileHandlerBenchmark.java b/src/test/java/org/lttng/ust/agent/benchmarks/jul/handler/builtin/FileHandlerBenchmark.java
index 41a8baedfd08e6038cb2803aa2c6abb3827adf3e..af4ab7ceb52dc589c13366e273e136aa961b0f66 100644 (file)
--- a/src/test/java/org/lttng/ust/agent/benchmarks/jul/handler/builtin/FileHandlerBenchmark.java
+++ b/src/test/java/org/lttng/ust/agent/benchmarks/jul/handler/builtin/FileHandlerBenchmark.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.builtin;
 
 import java.io.IOException;
@@ -10,20 +28,37 @@ import org.junit.After;
 import org.junit.Before;
 import org.lttng.ust.agent.benchmarks.jul.handler.JulHandlerBenchmarkBase;
 
+/**
+ * Test class using a {@link FileHandler}, which a {@link SimpleFormatter}.
+ */
 public class FileHandlerBenchmark extends JulHandlerBenchmarkBase {
 
     private Path outputFile;
 
-    @Before
-    public void testSetup() throws SecurityException, IOException {
-        outputFile = Files.createTempFile(this.getClass().getSimpleName(), null);
+       /**
+        * Test setup
+        *
+        * @throws SecurityException
+        *             If there is problem setting up the handler
+        * @throws IOException
+        *             If there is problem setting up the handler
+        */
+       @Before
+       public void testSetup() throws SecurityException, IOException {
+               outputFile = Files.createTempFile(this.getClass().getSimpleName(), null);
 
-        handler = new FileHandler(outputFile.toString(), false);
-        handler.setFormatter(new SimpleFormatter());
-    }
+               handler = new FileHandler(outputFile.toString(), false);
+               handler.setFormatter(new SimpleFormatter());
+       }
 
-    @After
-    public void testTeardown() throws IOException {
-        Files.deleteIfExists(outputFile);
-    }
+       /**
+        * Test cleanup
+        *
+        * @throws IOException
+        *             If we could not delete the test file
+        */
+       @After
+       public void testTeardown() throws IOException {
+               Files.deleteIfExists(outputFile);
+       }
 }