org.assertj.db.util

Enum NameComparator

java.lang.Object

java.lang.Enum<NameComparator>

org.assertj.db.util.NameComparator

All Implemented Interfaces:

Serializable, Comparable<NameComparator>

public enum NameComparator
extends Enum<NameComparator>

Comparator for the names.

Since:

1.1.0

Author:

Régis Pouiller

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE The singleton

Method Summary

Modifier and Type	Method and Description
boolean	contains(List<String> namesList, String name, CaseComparison comparison) Returns if namesList contains name by comparing using comparison.
int	indexOf(List<String> namesList, String name, CaseComparison comparison) Returns the index of namein namesList by comparing using comparison.
static NameComparator	valueOf(String name) Returns the enum constant of this type with the specified name.
static NameComparator[]	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

INSTANCE

public static final NameComparator INSTANCE

The singleton

Method Detail

values

public static NameComparator[] 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 (NameComparator c : NameComparator.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static NameComparator 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

contains

public boolean contains(List<String> namesList,
                        String name,
                        CaseComparison comparison)

Returns if namesList contains name by comparing using comparison.

Parameters:

namesList - List of names which can contain the name.

name - The name to search.

comparison - Case comparison to compare the name.

Returns:

The result.

indexOf

public int indexOf(List<String> namesList,
                   String name,
                   CaseComparison comparison)

Returns the index of namein namesList by comparing using comparison.

Parameters:

namesList - List of names which can contain the name.

name - The name to search.

comparison - Case comparison to compare the name.

Returns:

The result.