MatchKey (uk.gov.gchq.gaffer:gaffer2 2.3.1 API)

java.lang.Object
- java.lang.Enum<MatchKey>
- - uk.gov.gchq.gaffer.operation.impl.join.match.MatchKey

All Implemented Interfaces:

Serializable, Comparable<MatchKey>
```
public enum MatchKey
extends Enum<MatchKey>
```
Used to specify whether the matching is done Left to Right (LEFT) or Right to Left (RIGHT)

Enum Constant Summary

Enum Constants
Enum Constant Description

LEFT

RIGHT

Method Summary

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

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

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

- Enum Constant Detail
  - LEFT
```
public static final MatchKey LEFT
```
  - RIGHT
```
public static final MatchKey RIGHT
```
- Method Detail
  - values
```
public static MatchKey[] 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 (MatchKey c : MatchKey.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static MatchKey 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