Package com.palantir.baseline.errorprone.safety

Enum Safety

java.lang.Object

java.lang.Enum<Safety>

com.palantir.baseline.errorprone.safety.Safety

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Safety>, org.checkerframework.errorprone.dataflow.analysis.AbstractValue<Safety>

public enum Safety
extends java.lang.Enum<Safety>
implements org.checkerframework.errorprone.dataflow.analysis.AbstractValue<Safety>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DO_NOT_LOG
SAFE
UNKNOWN
UNSAFE

Method Summary

Modifier and Type	Method	Description
boolean	allowsAll()
abstract boolean	allowsValueWith(Safety valueSafety)
static Safety	mergeAssumingUnknownIsSame(Safety first, Safety second)	Merge Safety using AbstractValue.leastUpperBound(AbstractValue) except that UNKNOWN assumes no confidence, preferring the other type if data is available.
static Safety	mergeAssumingUnknownIsSame(Safety one, Safety two, Safety three)
static Safety	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static Safety[]	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

Methods inherited from interface org.checkerframework.errorprone.dataflow.analysis.AbstractValue

leastUpperBound

Enum Constant Detail

UNKNOWN

public static final Safety UNKNOWN

DO_NOT_LOG

public static final Safety DO_NOT_LOG

UNSAFE

public static final Safety UNSAFE

SAFE

public static final Safety SAFE

Method Detail

values

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

Returns:

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

valueOf

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

allowsValueWith

public abstract boolean allowsValueWith(Safety valueSafety)

allowsAll

public boolean allowsAll()

mergeAssumingUnknownIsSame

public static Safety mergeAssumingUnknownIsSame(Safety first,
                                                Safety second)

Merge Safety using AbstractValue.leastUpperBound(AbstractValue) except that UNKNOWN assumes no confidence, preferring the other type if data is available. For example, casting from Object to a known-safe type should result in SAFE.

mergeAssumingUnknownIsSame

public static Safety mergeAssumingUnknownIsSame(Safety one,
                                                Safety two,
                                                Safety three)