Package nl.talsmasoftware.umldoclet.javadoc.dependencies

Class PackageDependency

java.lang.Object

nl.talsmasoftware.umldoclet.javadoc.dependencies.PackageDependency

public class PackageDependency
extends Object

Package dependency.

Contains a 'from' package and a 'to' package. A (from) package has a dependency on a (to) package if there is at least one element in the 'from' package that needs at least one element in the 'to' package.

This class overrides equals and hashCode methods so unique package dependencies can easily be included in hashed collections.

Author:

Sjoerd Talsma

Field Summary

Fields

Modifier and Type	Field	Description
final String	fromPackage	The qualified name of the depending package.
final String	toPackage	The qualified name of the depended-upon package.

Constructor Summary

Constructors

Constructor	Description
PackageDependency(String fromPackage, String toPackage)	Create a new package dependency object.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object other)	Equal implementation based on the fromPackage and toPackage values.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

fromPackage

public final String fromPackage

The qualified name of the depending package. This package contains at least one element that has a dependency on an element in the toPackage.

toPackage

public final String toPackage

The qualified name of the depended-upon package. This package contains at least one element that is needed by an element in the fromPackage.

Constructor Details

PackageDependency

public PackageDependency(String fromPackage,
 String toPackage)

Create a new package dependency object.

Parameters:

fromPackage - The package that has a dependency on another package.

toPackage - The package that is depended upon.

Method Details

hashCode

public int hashCode()

Overrides:

hashCode in class Object

Returns:

Hashcode implementation based on the fromPackage and toPackage values.

equals

public boolean equals(Object other)

Equal implementation based on the fromPackage and toPackage values.

Overrides:

equals in class Object

Parameters:

other - The other object to compare with.

Returns:

true if the other object is also a PackageDependency and contains the same fromPackage and toPackage values, false otherwise.

toString

public String toString()

Overrides:

toString in class Object

Returns:

Human-readable representation of this package dependency.