-Added a class to serve up results to atom. A matching client C++ class should follow shortly.
-Generally beautified code
git-svn-id: https://robotics.mvla.net/svn/frc971/2013/trunk/src@4148 f308d9b7-e957-4cde-b6ac-9a88185e7312
diff --git a/971CV/src/org/frc971/LogHandler.java b/971CV/src/org/frc971/LogHandler.java
index 59f74a9..fd486fb 100644
--- a/971CV/src/org/frc971/LogHandler.java
+++ b/971CV/src/org/frc971/LogHandler.java
@@ -12,13 +12,20 @@
/**
* @author daniel
- * logs data to custom files, using specific formatting.
+ *
*/
+
+/** Logs data to custom files, using specific formatting. */
public class LogHandler extends Handler {
private FileOutputStream ofstream;
PrintWriter writer;
+ /** Constructor for log handler.
+ *
+ * @param filename is the name of the file you want to log to.
+ * @throws FileNotFoundException if file cannot be opened or created.
+ */
public LogHandler (String filename) throws FileNotFoundException {
super();
@@ -34,6 +41,9 @@
/*Required methods*/
+ /** Is required by API. Writes a new message to the log.
+ * @param message is the message you want to log.
+ */
public void publish(LogRecord message) {
//record a message
if (!isLoggable(message)) {
@@ -42,9 +52,13 @@
}
writer.print(getFormatter().format(message)); //Formatter adds trailing \n
}
+
+ /** Is required by API. Flushes the writer. */
public void flush() {
writer.flush();
}
+
+ /** Is required by API. Closes logfile. */
public void close() throws SecurityException {
writer.close();
}