Package org.openscience.cdk.tools.manipulator

Class RingSizeComparator

java.lang.Object

org.openscience.cdk.tools.manipulator.RingSizeComparator

All Implemented Interfaces:

Comparator<IRing>

public class RingSizeComparator
extends Object
implements Comparator<IRing>

Source code:

main

Belongs to CDK module:

standard

Field Summary

Fields

Modifier and Type	Field	Description
static final int	LARGE_FIRST	Flag to denote that the set is order with the largest ring first
static final int	SMALL_FIRST	Flag to denote that the set is order with the smallest ring first

Constructor Summary

Constructors

Constructor	Description
RingSizeComparator(int order)	Constructs a new comparator to sort rings by size.

Method Summary

Modifier and Type	Method	Description
int	compare(IRing object1, IRing object2)

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, reversed, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Field Details

LARGE_FIRST

public static final int LARGE_FIRST

Flag to denote that the set is order with the largest ring first

See Also:

• Constant Field Values

SMALL_FIRST

public static final int SMALL_FIRST

Flag to denote that the set is order with the smallest ring first

See Also:

• Constant Field Values

Constructor Details

RingSizeComparator

public RingSizeComparator(int order)

Constructs a new comparator to sort rings by size.

Parameters:

order - Sort order: either RingSet.SMALL_FIRST or RingSet.LARGE_FIRST.

Method Details

compare

public int compare(IRing object1,
 IRing object2)
            throws ClassCastException

Specified by:

compare in interface Comparator<IRing>

Throws:

ClassCastException