com.tensegrity.graph.classdiagram
Class ClassDiagramConfiguration

java.lang.Object
  com.tensegrity.graph.classdiagram.ClassDiagramConfiguration

public class ClassDiagramConfiguration

extends java.lang.Object

This class encapsulates a single configuration for the generator class ClassDiagramGenerator.

Version:

$Id: ClassDiagramConfiguration.java,v 1.4 2003/10/22 17:14:07 sr Exp $

Author:

StepanRutz

Constructor Summary

ClassDiagramConfiguration(java.lang.String name, java.util.Collection classes)
Constructs a new ClassDiagramGenerator instance.

Method Summary

ClassDiagramFilter	getClassDiagramFilter() Returns the currently active class filter of type ClassDiagramFilter or null is none is set.
java.util.Collection	getClasses() Returns a non-modifyable collection of classes to scan.
java.lang.String	getName() Returns the name of this ClassDiagramGenerator instance.
boolean	isDoClasses() Returns the current setting of the flag doClasses.
boolean	isDoInterfaces() Returns the current setting of the flag doInterfaces.
boolean	isDoMethods() Returns the current setting of the flag doMethods.
void	setClassDiagramFilter(ClassDiagramFilter filter) Sets the filter-predicate that is used to sort out classes or interfaces from the generation process in a user-defined way.
void	setDoClasses(boolean doClasses) Whether to follow the superclass when tracing a single class.
void	setDoInterfaces(boolean doInterfaces) Whether to follow super-interfaces when tracing a single class.
void	setDoMethods(boolean doMethods) Whether to include methods in the visualization.

Methods inherited from class java.lang.Object

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

Constructor Detail

ClassDiagramConfiguration

public ClassDiagramConfiguration(java.lang.String name,
                                 java.util.Collection classes)

Constructs a new ClassDiagramGenerator instance.

Parameters:

name - the name of this configuration instance.

classes - a Collection of classes that are the roots of the class hierarchy traversal.

Method Detail

getName

public final java.lang.String getName()

Returns the name of this ClassDiagramGenerator instance.

Returns:

the name of this ClassDiagramGenerator instance.

getClasses

public final java.util.Collection getClasses()

Returns a non-modifyable collection of classes to scan.

Returns:

a non-modifyable collection of classes to scan.

isDoClasses

public final boolean isDoClasses()

Returns the current setting of the flag doClasses.

Returns:

the current setting of the flag doClasses.

setDoClasses

public final void setDoClasses(boolean doClasses)

Whether to follow the superclass when tracing a single class.

isDoInterfaces

public final boolean isDoInterfaces()

Returns the current setting of the flag doInterfaces.

Returns:

the current setting of the flag doInterfaces.

setDoInterfaces

public final void setDoInterfaces(boolean doInterfaces)

Whether to follow super-interfaces when tracing a single class.

Parameters:

doInterfaces - true if super-interfaces are to be traced, otherwise false

isDoMethods

public final boolean isDoMethods()

Returns the current setting of the flag doMethods.

Returns:

the current setting of the flag doMethods.

setDoMethods

public final void setDoMethods(boolean doMethods)

Whether to include methods in the visualization.

Parameters:

doMethods - true if methods should be included in the visualization.

getClassDiagramFilter

public final ClassDiagramFilter getClassDiagramFilter()

Returns the currently active class filter of type ClassDiagramFilter or null is none is set.

Returns:

he currently active class filter.

setClassDiagramFilter

public final void setClassDiagramFilter(ClassDiagramFilter filter)

Sets the filter-predicate that is used to sort out classes or interfaces from the generation process in a user-defined way.

Parameters:

filter - the ClassDiagramFilter to customize the class-diagram-generation.