Package com.gradle.scan.eventmodel.gradle

Class DeprecatedUsage_1_0

java.lang.Object

com.gradle.scan.eventmodel.gradle.DeprecatedUsage_1_0

All Implemented Interfaces:

com.gradle.scan.eventmodel.EventData

Direct Known Subclasses:

DeprecatedUsage_1_1

@GradleVersion(since="4.10")
@PluginVersion(since="1.16",
               until="2.1")
public class DeprecatedUsage_1_0
extends Object
implements com.gradle.scan.eventmodel.EventData

An individual usage of a deprecated Gradle feature.

Field Summary

Fields

Modifier and Type	Field	Description
final @Nullable("when no advice specific to this usage is available") String	contextualAdvice	Advice on how to avoid using the deprecated feature, that is specific to this particular usage.
final long	notice	The ID of the DeprecationNotice_1_0 that describes the deprecated thing that was used.
final @Nullable("when no logical owner can be determined") DeprecatedUsageOwnerRef_1_0	owner	The logical entity that owns the usage (e.g.
final @Nullable("when build scan plugin >= 2.2") Long	stackTrace	The key of the stack trace in DeprecatedUsageTraceData_1_0.stackTraces indicating the call stack when the deprecated thing was used.

Constructor Summary

Constructors

Constructor	Description
DeprecatedUsage_1_0(long notice, @Nullable Long stackTrace, @Nullable String contextualAdvice, @Nullable DeprecatedUsageOwnerRef_1_0 owner)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

notice

public final long notice

The ID of the DeprecationNotice_1_0 that describes the deprecated thing that was used.

More than one usage may be of the same notice (i.e. deprecated feature).

stackTrace

@Nullable("when build scan plugin >= 2.2")
public final @Nullable("when build scan plugin >= 2.2") Long stackTrace

The key of the stack trace in DeprecatedUsageTraceData_1_0.stackTraces indicating the call stack when the deprecated thing was used.

A usage may share the same stack trace as another.

Traces are only present for notices of type USER_CODE_DIRECT.

contextualAdvice

@Nullable("when no advice specific to this usage is available")
public final @Nullable("when no advice specific to this usage is available") String contextualAdvice

Advice on how to avoid using the deprecated feature, that is specific to this particular usage.

owner

@Nullable("when no logical owner can be determined")
public final @Nullable("when no logical owner can be determined") DeprecatedUsageOwnerRef_1_0 owner

The logical entity that owns the usage (e.g. the plugin or script).

Constructor Details

DeprecatedUsage_1_0

public DeprecatedUsage_1_0(long notice,
 @Nullable
 @Nullable Long stackTrace,
 @Nullable
 @Nullable String contextualAdvice,
 @Nullable
 @Nullable DeprecatedUsageOwnerRef_1_0 owner)

Method Details

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object