Enum Class AbstractEqualsHashCodeUsageChecker.Usage

java.lang.Object

java.lang.Enum<AbstractEqualsHashCodeUsageChecker.Usage>

com.google.errorprone.bugpatterns.AbstractEqualsHashCodeUsageChecker.Usage

All Implemented Interfaces:

Serializable, Comparable<AbstractEqualsHashCodeUsageChecker.Usage>, Constable

Enclosing class:

AbstractEqualsHashCodeUsageChecker

protected static enum AbstractEqualsHashCodeUsageChecker.Usage
extends Enum<AbstractEqualsHashCodeUsageChecker.Usage>

A way that code can rely on the equals or hashCode of a type.

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ASSERTION	An equality assertion, e.g.
CONTAINMENT	A method that compares elements with equals, e.g.
EQUALS	A direct call to equals, e.g.
HASH_KEY	Creating a hash-based container, e.g. a Set element or a Map, Multimap, or Multiset key, or a BiMap value.

Method Summary

Modifier and Type	Method	Description
static AbstractEqualsHashCodeUsageChecker.Usage	valueOf(String name)	Returns the enum constant of this class with the specified name.
static AbstractEqualsHashCodeUsageChecker.Usage[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

EQUALS

public static final AbstractEqualsHashCodeUsageChecker.Usage EQUALS

A direct call to equals, e.g. a.equals(b) or Objects.equals(a, b).

ASSERTION

public static final AbstractEqualsHashCodeUsageChecker.Usage ASSERTION

An equality assertion, e.g. assertEquals(a, b) or Truth's isEqualTo.

CONTAINMENT

public static final AbstractEqualsHashCodeUsageChecker.Usage CONTAINMENT

A method that compares elements with equals, e.g. Collection.contains.

HASH_KEY

public static final AbstractEqualsHashCodeUsageChecker.Usage HASH_KEY

Creating a hash-based container, e.g. a Set element or a Map, Multimap, or Multiset key, or a BiMap value.

Method Details

values

public static AbstractEqualsHashCodeUsageChecker.Usage[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static AbstractEqualsHashCodeUsageChecker.Usage valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null