jdepend.framework
Class PackageComparator

java.lang.Object
  jdepend.framework.PackageComparator

All Implemented Interfaces:

java.util.Comparator

public class PackageComparator

extends java.lang.Object

implements java.util.Comparator

The PackageComparator class is a Comparator used to compare two JavaPackage instances for order using a sorting strategy.

Author:

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(java.lang.Object p1, java.lang.Object p2) Compares the specified objects for order.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Comparator

equals

Constructor Detail

PackageComparator

public PackageComparator(PackageComparator byWhat)

Constructs a PackageComparator with the specified comparison strategy.

Parameters:

byWhat - Comparison strategy.

Method Detail

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(java.lang.Object p1,
                   java.lang.Object p2)

Compares the specified objects for order.

Specified by:

compare in interface java.util.Comparator

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.