jdepend.swingui

Class PackageNode

public abstract class PackageNode extends Object

The PackageNode class defines the default behavior for tree nodes representing Java packages.

Author: Mike Clark (mike@clarkware.com) Clarkware Consulting, Inc.

Constructor Summary
PackageNode(PackageNode parent, JavaPackage jPackage)
Constructs a PackageNode with the specified package and its collection of dependent packages.
Method Summary
ArrayListgetChildren()
Returns the child package nodes of this node.
protected abstract CollectiongetCoupledPackages()
Returns the collection of Java packages coupled to the package represented in this node.
JavaPackagegetPackage()
Returns the Java package represented in this node.
PackageNodegetParent()
Returns the parent of this package node.
booleanisChild(JavaPackage jPackage)
Indicates whether the specified package should be displayed as a child of this node.
booleanisLeaf()
Indicates whether this node is a leaf node.
protected abstract PackageNodemakeNode(PackageNode parent, JavaPackage jPackage)
Creates and returns a PackageNode with the specified parent node and Java package.
StringtoMetricsString()
Returns the string representation of this node's metrics.
StringtoString()
Returns the string representation of this node in it's current tree context.

Constructor Detail

PackageNode

public PackageNode(PackageNode parent, JavaPackage jPackage)
Constructs a PackageNode with the specified package and its collection of dependent packages.

Parameters: parent Parent package node. jPackage Java package.

Method Detail

getChildren

public ArrayList getChildren()
Returns the child package nodes of this node.

Returns: Collection of child package nodes.

getCoupledPackages

protected abstract Collection getCoupledPackages()
Returns the collection of Java packages coupled to the package represented in this node.

Returns: Collection of coupled packages.

getPackage

public JavaPackage getPackage()
Returns the Java package represented in this node.

Returns: Java package.

getParent

public PackageNode getParent()
Returns the parent of this package node.

Returns: Parent package node.

isChild

public boolean isChild(JavaPackage jPackage)
Indicates whether the specified package should be displayed as a child of this node.

Parameters: jPackage Package to test.

Returns: true to display the package; false otherwise.

isLeaf

public boolean isLeaf()
Indicates whether this node is a leaf node.

Returns: true if this node is a leaf; false otherwise.

makeNode

protected abstract PackageNode makeNode(PackageNode parent, JavaPackage jPackage)
Creates and returns a PackageNode with the specified parent node and Java package.

Parameters: parent Parent package node. jPackage Java package.

Returns: A non-null PackageNode

toMetricsString

public String toMetricsString()
Returns the string representation of this node's metrics.

Returns: Metrics string.

toString

public String toString()
Returns the string representation of this node in it's current tree context.

Returns: Node label.

Copyright B) 1999-2003 Clarkware Consulting, Inc.