AnnotationToComparatorDictionary (JEntityTest 1.0.0 API)

java.lang.Object
- org.testmonkeys.jentitytest.model.AnnotationToComparatorDictionary

```
public final class AnnotationToComparatorDictionary
extends Object
```
Annotation to comparator mapping class. This class is used during Entity inspection, and based on registered mappings will provide the comparators for annotations used in the Entity.
Contains default comparisons but can register new annotations to comparator mappings at runtime.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Comparator`	`getComparatorForAnnotation(Annotation annotation)` Gets the comparator assigned to the provided annotation
`static AnnotationToComparatorDictionary`	`getInstance()`
`AbstractAbortCondition`	`getPreComparisonCheckForAnnotation(Annotation annotation)` Gets the comparator assigned to the provided annotation
`AbstractValidation`	`getValidationForAnnotation(Annotation annotation)` Gets the comparator assigned to the provided annotation
`boolean`	`hasComparatorAssigned(Annotation annotation)` Checks if provided annotation is linked to a comparator
`boolean`	`hasPreConditionalCheckAssigned(Annotation candidate)` Checks if provided annotation is linked to a comparator
`boolean`	`hasValidationCheckAssigned(Annotation candidate)` Checks if provided annotation is linked to a validator
`void`	`setComparatorForAnnotation(Class<? extends Comparator> comparator, Class<?> annotation)` Register or overwrite a mapping between an annotation and a comparator
`void`	`setPreConditionalCheckForAnnotation(Class<? extends AbstractAbortCondition> comparator, Class<?> annotation)` Register or overwrite a mapping between an annotation and a comparator
`void`	`setValidatorForAnnotation(Class<? extends AbstractValidation> comparator, Class<?> annotation)` Register or overwrite a mapping between an annotation and a comparator

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

- Method Detail
  - getInstance
```
public static AnnotationToComparatorDictionary getInstance()
```
  - hasComparatorAssigned
```
public boolean hasComparatorAssigned(Annotation annotation)
```
    Checks if provided annotation is linked to a comparator
    
    Parameters:
    
    annotation - annotation to check
    
    Returns:
    
    boolean result of verification
  - hasPreConditionalCheckAssigned
```
public boolean hasPreConditionalCheckAssigned(Annotation candidate)
```
    Checks if provided annotation is linked to a comparator
    
    Parameters:
    
    candidate - annotation to check
    
    Returns:
    
    boolean result of verification
  - hasValidationCheckAssigned
```
public boolean hasValidationCheckAssigned(Annotation candidate)
```
    Checks if provided annotation is linked to a validator
    
    Parameters:
    
    candidate - annotation to check
    
    Returns:
    
    boolean result of verification
  - setComparatorForAnnotation
```
public void setComparatorForAnnotation(Class<? extends Comparator> comparator,
                                       Class<?> annotation)
```
    Register or overwrite a mapping between an annotation and a comparator
    
    Parameters:
    
    comparator - comparator to register
    
    annotation - annotation to register
    
    Throws:
    
    JEntityTestException - in case the comparator or annotation is null
  - setPreConditionalCheckForAnnotation
```
public void setPreConditionalCheckForAnnotation(Class<? extends AbstractAbortCondition> comparator,
                                                Class<?> annotation)
```
    Register or overwrite a mapping between an annotation and a comparator
    
    Parameters:
    
    comparator - comparator to register
    
    annotation - annotation to register
    
    Throws:
    
    JEntityTestException - in case the comparator or annotation is null
  - setValidatorForAnnotation
```
public void setValidatorForAnnotation(Class<? extends AbstractValidation> comparator,
                                      Class<?> annotation)
```
    Register or overwrite a mapping between an annotation and a comparator
    
    Parameters:
    
    comparator - comparator to register
    
    annotation - annotation to register
    
    Throws:
    
    JEntityTestException - in case the comparator or annotation is null
  - getComparatorForAnnotation
```
public Comparator getComparatorForAnnotation(Annotation annotation)
```
    Gets the comparator assigned to the provided annotation
    
    Parameters:
    
    annotation - annotation
    
    Returns:
    
    Comparator for provided annotation
    
    Throws:
    
    JEntityTestException - in case comparator could not be provided
  - getPreComparisonCheckForAnnotation
```
public AbstractAbortCondition getPreComparisonCheckForAnnotation(Annotation annotation)
```
    Gets the comparator assigned to the provided annotation
    
    Parameters:
    
    annotation - annotation
    
    Returns:
    
    Comparator for provided annotation
    
    Throws:
    
    JEntityTestException - in case comparator could not be provided
  - getValidationForAnnotation
```
public AbstractValidation getValidationForAnnotation(Annotation annotation)
```
    Gets the comparator assigned to the provided annotation
    
    Parameters:
    
    annotation - annotation
    
    Returns:
    
    Comparator for provided annotation
    
    Throws:
    
    JEntityTestException - in case comparator could not be provided

Class AnnotationToComparatorDictionary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getInstance

hasComparatorAssigned

hasPreConditionalCheckAssigned

hasValidationCheckAssigned

setComparatorForAnnotation

setPreConditionalCheckForAnnotation

setValidatorForAnnotation

getComparatorForAnnotation

getPreComparisonCheckForAnnotation

getValidationForAnnotation