Package tech.picnic.errorprone.bugpatterns.util

Enum ThirdPartyLibrary

java.lang.Object

java.lang.Enum<ThirdPartyLibrary>

tech.picnic.errorprone.bugpatterns.util.ThirdPartyLibrary

All Implemented Interfaces:

Serializable, Comparable<ThirdPartyLibrary>, java.lang.constant.Constable

public enum ThirdPartyLibrary
extends Enum<ThirdPartyLibrary>

Utility class that helps decide whether it is appropriate to introduce references to (well-known) third-party libraries.

This class should be used by BugCheckers that may otherwise suggest the introduction of code that depends on possibly-not-present third-party libraries.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ASSERTJ	AssertJ.
GUAVA	Google's Guava.
NEW_RELIC_AGENT_API	New Relic's Java agent API.
REACTOR	VMWare's Project Reactor.

Method Summary

Modifier and Type	Method	Description
boolean	isIntroductionAllowed(com.google.errorprone.VisitorState state)	Tells whether it is okay to introduce a dependency on this well-known third party library in the given context.
static ThirdPartyLibrary	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ThirdPartyLibrary[]	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, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ASSERTJ

public static final ThirdPartyLibrary ASSERTJ

AssertJ.

See Also:

• AssertJ documentation

GUAVA

public static final ThirdPartyLibrary GUAVA

Google's Guava.

See Also:

• Guava on GitHub

NEW_RELIC_AGENT_API

public static final ThirdPartyLibrary NEW_RELIC_AGENT_API

New Relic's Java agent API.

See Also:

• New Relic Java agent API on GitHub

REACTOR

public static final ThirdPartyLibrary REACTOR

VMWare's Project Reactor.

See Also:

• Home page

Method Details

values

public static ThirdPartyLibrary[] values()

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

Returns:

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

valueOf

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

isIntroductionAllowed

public boolean isIntroductionAllowed(com.google.errorprone.VisitorState state)

Tells whether it is okay to introduce a dependency on this well-known third party library in the given context.

Parameters:

state - The context under consideration.

Returns:

true iff it is okay to assume or create a dependency on this library.