com.squareup.leakcanary

Enum Reachability

java.lang.Object

java.lang.Enum<Reachability>

com.squareup.leakcanary.Reachability

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Reachability>

public enum Reachability
extends java.lang.Enum<Reachability>

Result returned by Reachability.Inspector.expectedReachability(LeakTraceElement).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Reachability.Inspector Evaluates whether a LeakTraceElement should be reachable or not.

Enum Constant Summary

Enum Constants

Enum Constant and Description
REACHABLE The instance was needed and therefore expected to be reachable.
UNKNOWN No decision can be made about the provided instance.
UNREACHABLE The instance was no longer needed and therefore expected to be unreachable.

Method Summary

Modifier and Type	Method and Description
static Reachability	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Reachability[]	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

REACHABLE

public static final Reachability REACHABLE

The instance was needed and therefore expected to be reachable.

UNREACHABLE

public static final Reachability UNREACHABLE

The instance was no longer needed and therefore expected to be unreachable.

UNKNOWN

public static final Reachability UNKNOWN

No decision can be made about the provided instance.

Method Detail

values

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

Returns:

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

valueOf

public static Reachability valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null