stevel 2002/06/22 23:44:25
Modified: src/main/org/apache/tools/ant/taskdefs/optional/sitraka Tag:
ANT_15_BRANCH Filters.java Socket.java
Triggers.java
Log:
I'm not sure I fully understand the function of the enabled tag, because it
not a simple 'use this filter' if enabled=true thing, the enabled flag becomes
part of the argument to jprobe. Someone who knows the task will need to correct
the docs.
As an aside, ant:tdg does list this flag, so they did look at the code in
places after all, just never bothered to file a bugrep when they found
something missing. Sigh. They just never looked at EchoTask :)
Revision Changes Path
No revision
No revision
1.7.2.1 +31 -1
jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/sitraka/Filters.java
Index: Filters.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/sitraka/Filters.java,v
retrieving revision 1.7
retrieving revision 1.7.2.1
diff -u -r1.7 -r1.7.2.1
--- Filters.java 16 Apr 2002 06:43:04 -0000 1.7
+++ Filters.java 23 Jun 2002 06:44:25 -0000 1.7.2.1
@@ -75,14 +75,24 @@
public Filters() {
}
+ /**
+ * Automatically exclude all classes and methods
+ * unless included in nested elements; optional, default true.
+ */
public void setDefaultExclude(boolean value) {
defaultExclude = value;
}
+ /**
+ * include classes and methods in the analysis
+ */
public void addInclude(Include incl) {
filters.addElement(incl);
}
+ /**
+ * exclude classes and methods from the analysis
+ */
public void addExclude(Exclude excl) {
filters.addElement(excl);
}
@@ -105,23 +115,43 @@
return buf.toString();
}
+ /**
+ * an includes or excludes element
+ */
public abstract static class FilterElement {
protected String clazz;
protected String method = "*"; // default is all methods
protected boolean enabled = true; // default is enable
- public void setName(String value) { // this one is deprecated.
+ /**
+ * this one is deprecated.
+ * @ant.task ignore="true"
+ */
+
+ public void setName(String value) {
clazz = value;
}
+ /**
+ * The classname mask as a simple regular expression;
+ * optional, defaults to "*"
+ */
public void setClass(String value) {
clazz = value;
}
+ /**
+ * The method mask as a simple regular expression;
+ * optional, defaults to "*"
+ */
public void setMethod(String value) {
method = value;
}
+ /**
+ * enable or disable the filter; optional, default true
+ */
+
public void setEnabled(boolean value) {
enabled = value;
}
1.4.2.1 +8 -1
jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/sitraka/Socket.java
Index: Socket.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/sitraka/Socket.java,v
retrieving revision 1.4
retrieving revision 1.4.2.1
diff -u -r1.4 -r1.4.2.1
--- Socket.java 10 Jan 2002 13:59:38 -0000 1.4
+++ Socket.java 23 Jun 2002 06:44:25 -0000 1.4.2.1
@@ -54,7 +54,7 @@
package org.apache.tools.ant.taskdefs.optional.sitraka;
/**
- * Socket element for connection.
+ * Define a host and port to connect to if you want to do remote viewing.
* <tt><socket/></tt> defaults to host 127.0.0.1 and port 4444
*
* Otherwise it requires the host and port attributes to be set:
@@ -70,10 +70,17 @@
/** default to 4444 */
private int port = 4444;
+ /**
+ * the host name/ip of the machine on which the Viewer is running;
+ * defaults to localhost.
+ */
public void setHost(String value) {
host = value;
}
+ /**
+ * Optional port number for the viewer; default is 4444
+ */
public void setPort(Integer value) {
port = value.intValue();
}
1.6.2.1 +28 -0
jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/sitraka/Triggers.java
Index: Triggers.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/sitraka/Triggers.java,v
retrieving revision 1.6
retrieving revision 1.6.2.1
diff -u -r1.6 -r1.6.2.1
--- Triggers.java 16 Apr 2002 06:43:04 -0000 1.6
+++ Triggers.java 23 Jun 2002 06:44:25 -0000 1.6.2.1
@@ -72,6 +72,10 @@
public Triggers() {
}
+
+ /**
+ * add a method trigger
+ */
public void addMethod(Method method) {
triggers.addElement(method);
}
@@ -90,16 +94,29 @@
}
+ /**
+ * A trigger for the coverage report
+ */
public static class Method {
protected String name;
protected String event;
protected String action;
protected String param;
+ /**
+ * The name of the method(s) as a regular expression. The name
+ * is the fully qualified name on the form
<tt>package.classname.method</tt>
+ * required.
+ */
public void setName(String value) {
name = value;
}
+ /**
+ * the event on the method that will trigger the action. Must be
+ * "enter" or "exit"
+ * required.
+ */
public void setEvent(String value) {
if (eventMap.get(value) == null) {
throw new BuildException("Invalid event, must be one of " +
eventMap);
@@ -107,6 +124,12 @@
event = value;
}
+ /**
+ * The action to execute; required. Must be one of "clear",
+ * "pause", "resume", "snapshot",
"suspend",
+ * or "exit". They respectively clear recording, pause
recording,
+ * resume recording, take a snapshot, suspend the recording and exit
the program.
+ */
public void setAction(String value) throws BuildException {
if (actionMap.get(value) == null) {
throw new BuildException("Invalid action, must be one of " +
actionMap);
@@ -114,6 +137,11 @@
action = value;
}
+ /**
+ * What does this do?
+ * @todo document
+ * @ant.attribute ignore="true"
+ */
public void setParam(String value) {
param = value;
}
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
