Excluding Java classes from dynamic tracing of method invocations

It is often necessary to exclude classes and methods from the trace and the resulting sequence diagram, to provide a clear picture that is not over crowded and to focus on the most relevant parts. Add the omit parameter 'omit=<regex>' to the sequence diagram tag, to exclude the matching classes from the sequence diagram. The <regexp> is a simplified regular expression that must either be an exact match or begin / end with an asterix (*). For example foo.Foo, *.Foo, or bar.*. Multiple omit patterns are separated by a comma (,).

Example

Given the class net.sf.jsequnit.example.SequenceSample containing a method excludeMethodsFromDiagram that calls methods of the following classes:

  • net.sf.jsequnit.example.SequenceSample
  • net.sf.jsequnit.example.foo.Foo
  • net.sf.jsequnit.example.bar.Bar

where the JavaDoc of the method contains a sequence diagram tag with the following omit parameter:

      @sequence.diagram
	    test=net.sf.jsequnit.example.SequenceSampleTest#testExludeMethodsFromDiagram()
	    omit=net.sf.jsequnit.example.foo.Foo,net.sf.jsequnit.example.bar.*
    

we get a sequence diagram containing methods calledByFoo and calledByBar of the class net.sf.jsequnit.example.SequenceSample, but without method calls to callBack of classes net.sf.jsequnit.example.foo.Foo and net.sf.jsequnit.example.bar.Bar.