XYSequencePointComparator.Comparison (adams-pom 24.12.0-SNAPSHOT API)

java.lang.Object
- java.lang.Enum<XYSequencePointComparator.Comparison>
- - adams.data.sequence.XYSequencePointComparator.Comparison

All Implemented Interfaces:

Serializable, Comparable<XYSequencePointComparator.Comparison>

Enclosing class:

XYSequencePointComparator<X extends Number & Comparable,Y extends Number & Comparable>
```
public static enum XYSequencePointComparator.Comparison
extends Enum<XYSequencePointComparator.Comparison>
```
The type of comparison to perform.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

Enum Constant Summary

Enum Constants
Enum Constant Description

X
only X.

X_AND_Y
X and Y.

Y
only Y.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method	Description
`static XYSequencePointComparator.Comparison`	`valueOf(String name)`	Returns the enum constant of this type with the specified name.
`static XYSequencePointComparator.Comparison[]`	`values()`	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - X
```
public static final XYSequencePointComparator.Comparison X
```
    only X.
  - Y
```
public static final XYSequencePointComparator.Comparison Y
```
    only Y.
  - X_AND_Y
```
public static final XYSequencePointComparator.Comparison X_AND_Y
```
    X and Y.
- Method Detail
  - values
```
public static XYSequencePointComparator.Comparison[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
    for (XYSequencePointComparator.Comparison c : XYSequencePointComparator.Comparison.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static XYSequencePointComparator.Comparison valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null