Overview Package Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

jdepend.swingui

Class PackageNode

Known Direct Subclasses:
AfferentNode, EfferentNode
public abstract class PackageNode
extends java.lang.Object
The PackageNode class defines the default behavior for tree nodes representing Java packages.

Authors:
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

ArrayList
getChildren()
Returns the child package nodes of this node.
protected Collection
getCoupledPackages()
Returns the collection of Java packages coupled to the package represented in this node.
JavaPackage
getPackage()
Returns the Java package represented in this node.
PackageNode
getParent()
Returns the parent of this package node.
boolean
isChild(JavaPackage jPackage)
Indicates whether the specified package should be displayed as a child of this node.
boolean
isLeaf()
Indicates whether this node is a leaf node.
protected PackageNode
makeNode(PackageNode parent, JavaPackage jPackage)
Creates and returns a PackageNode with the specified parent node and Java package.
String
toMetricsString()
Returns the string representation of this node's metrics.
String
toString()
Returns the string representation of this node in it's current tree context.

Constructor Details

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 Details

getChildren

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

Returns:
Collection of child package nodes.

getCoupledPackages

protected 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 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.

Overview Package Tree Index Deprecated About
Copyright B) 1999-2003 Clarkware Consulting, Inc.