org.umlgraph.doclet

Class ContextMatcher

java.lang.Object

org.umlgraph.doclet.ContextMatcher

All Implemented Interfaces:

ClassMatcher

public class ContextMatcher
extends java.lang.Object
implements ClassMatcher

Matches classes that are directly connected to one of the classes matched by the regual expression specified. The context center is computed by regex lookup. Depending on the specified Options, inferred relations and dependencies will be used as well.

This class needs to perform quite a bit of computations in order to gather the network of class releationships, so you are allowed to reuse it should you

Constructor Summary

Constructors

Constructor and Description
ContextMatcher(RootDoc root, java.util.regex.Pattern pattern, Options options, boolean keepParentHide) Builds the context matcher

Method Summary

Methods

Modifier and Type	Method and Description
boolean	matches(ClassDoc cd) Returns the options for the specified class.
void	setContextCenter(java.util.regex.Pattern pattern) Can be used to setup a different pattern for this context matcher.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ContextMatcher

public ContextMatcher(RootDoc root,
              java.util.regex.Pattern pattern,
              Options options,
              boolean keepParentHide)
               throws java.io.IOException

Builds the context matcher

Parameters:

root - The root doc returned by JavaDoc

pattern - The pattern that will match the "center" of this context

keepParentHide - If true, parent option hide patterns will be preserved, so that classes hidden by the options won't be shown in the context

Throws:

java.io.IOException

Method Detail

setContextCenter

public void setContextCenter(java.util.regex.Pattern pattern)

Can be used to setup a different pattern for this context matcher.

This can be used to speed up subsequent matching with the same global options, since the class network informations will be reused.

Parameters:

pattern -

matches

public boolean matches(ClassDoc cd)

Description copied from interface: ClassMatcher

Returns the options for the specified class.

Specified by:

matches in interface ClassMatcher

See Also:

org.umlgraph.doclet.ClassMatcher#matches(com.sun.javadoc.ClassDoc)