[slf4j-dev] svn commit: r1220 - slf4j/trunk/slf4j-ext/src/main/java/org/slf4j/agent

[ravn at slf4j.org]

Author: ravn
Date: Mon Oct 27 22:50:45 2008
New Revision: 1220

Added:
   slf4j/trunk/slf4j-ext/src/main/java/org/slf4j/agent/AgentOptions.java

Log:
put options in seperate file for documentation purposes

Added: slf4j/trunk/slf4j-ext/src/main/java/org/slf4j/agent/AgentOptions.java
==============================================================================
--- (empty file)
+++ slf4j/trunk/slf4j-ext/src/main/java/org/slf4j/agent/AgentOptions.java	Mon Oct 27 22:50:45 2008
@@ -0,0 +1,39 @@
+package org.slf4j.agent;
+
+/**
+ * <p>
+ * All recognized options in the string passed to the java agent. For
+ * "java -javaagent:foo.jar=OPTIONS HelloWorld" this would be "OPTIONS".
+ * </p>
+ * <p>
+ * It is considered to be a list of options separated by (currently) ";", on the
+ * form "option=value". The interpretation of "value" is specific to each
+ * option.
+ * </p>
+ */
+public class AgentOptions {
+
+  /**
+   * List of class prefixes to ignore when instrumenting. Note: Classes loaded
+   * before the agent cannot be instrumented.
+   */
+  public static final String IGNORE = "ignore";
+  /**
+   * Indicate the SLF4J level that should be used by the logging statements
+   * added by the agent. Default is "info".
+   */
+  public static final String LEVEL = "level";
+  /**
+   * Indicate that the agent should print out "new java.util.Date()" at the time
+   * the option was processed and at shutdown time (using the shutdown hook).
+   * 
+   */
+  public static final String TIME = "time";
+  /**
+   * Indicate that the agent should log actions to System.err, like adding
+   * logging to methods, etc.
+   * 
+   */
+  public static final String VERBOSE = "verbose";
+
+}