ComparisonRelation

java.lang.Object
- com.jnape.palatable.lambda.functions.ordering.ComparisonRelation

All Implemented Interfaces:

CoProduct3<ComparisonRelation.LessThan,ComparisonRelation.Equal,ComparisonRelation.GreaterThan,ComparisonRelation>

Direct Known Subclasses:

ComparisonRelation.Equal, ComparisonRelation.GreaterThan, ComparisonRelation.LessThan
```
public abstract class ComparisonRelation
extends java.lang.Object
implements CoProduct3<ComparisonRelation.LessThan,ComparisonRelation.Equal,ComparisonRelation.GreaterThan,ComparisonRelation>
```
Specialized CoProduct3 representing the possible results of a ordered comparison. Used by Compare as the result of a comparison.

See Also:

Compare

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class ComparisonRelation.Equal

static class ComparisonRelation.GreaterThan

static class ComparisonRelation.LessThan

Constructor Summary

Constructors
Modifier Constructor Description

private ComparisonRelation()

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method	Description
`static ComparisonRelation.Equal`	`equal()`
`static ComparisonRelation`	`fromInt(int signifier)`	Return a comparison relation from the result of a `Comparator` or `Comparable` result
`static ComparisonRelation.GreaterThan`	`greaterThan()`
`static ComparisonRelation.LessThan`	`lessThan()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.jnape.palatable.lambda.adt.coproduct.CoProduct3
converge, diverge, embed, match, project, projectA, projectB, projectC

- Constructor Detail
  - ComparisonRelation
```
private ComparisonRelation()
```
- Method Detail
  - fromInt
```
public static ComparisonRelation fromInt(int signifier)
```
    Return a comparison relation from the result of a Comparator or Comparable result
    
    Parameters:
    
    signifier - The result of Comparator.compare(Object, Object) or Comparable.compareTo(Object)
    
    Returns:
    
    The intended ComparisonRelation of the signifier
  - greaterThan
```
public static ComparisonRelation.GreaterThan greaterThan()
```
  - lessThan
```
public static ComparisonRelation.LessThan lessThan()
```
  - equal
```
public static ComparisonRelation.Equal equal()
```