jdepend.framework

Class PackageComparator

Implemented Interfaces:
Comparator

public class PackageComparator
extends java.lang.Object
implements Comparator

The PackageComparator class is a Comparator used to compare two JavaPackage instances for order using a sorting strategy.
Authors:
Mike Clark (mike@clarkware.com)
Clarkware Consulting, Inc.

Constructor Summary

PackageComparator(PackageComparator byWhat)
Constructs a PackageComparator with the specified comparison strategy.

Method Summary

static PackageComparator
byName()
Returns a comparator for the package name.
PackageComparator
byWhat()
Returns the current comparison strategy.
int
compare(Object p1, Object p2)
Compares the specified objects for order.

Constructor Details

PackageComparator

public PackageComparator(PackageComparator byWhat)
Constructs a PackageComparator with the specified comparison strategy.
Parameters:
byWhat - Comparison strategy.

Method Details

byName

public static PackageComparator byName()
Returns a comparator for the package name.
Returns:
Package name comparator.

byWhat

public PackageComparator byWhat()
Returns the current comparison strategy.
Returns:
Comparison strategy.

compare

public int compare(Object p1,
                   Object p2)
Compares the specified objects for order.
Parameters:
p1 - First package.
p2 - Second package.
Returns:
A negative integer, zero, or a positive integer as the first object is less than, equal to, or greater than the second object.

Copyright B) 1999-2003 Clarkware Consulting, Inc.