Package io.github.duckasteroid.agentdocs.resolve.task

Record Class AppliedPluginCollector.DeclaredPlugin

java.lang.Object

java.lang.Record

io.github.duckasteroid.agentdocs.resolve.task.AppliedPluginCollector.DeclaredPlugin

Record Components:

coordinate - the plugin's identity

jarPath - the plugin's own resolved jar (from its classloader's code source)

declaration - the plugin jar's Agent-Docs declaration

Enclosing class:

AppliedPluginCollector

public static record AppliedPluginCollector.DeclaredPlugin(GradlePluginCoordinate coordinate, Path jarPath, AgentDocsDeclaration declaration)
extends Record

Discovered Agent-Docs-aware Gradle plugin, analogous to a declared dependency.

Constructor Summary

Constructors

Constructor	Description
DeclaredPlugin(GradlePluginCoordinate coordinate, Path jarPath, AgentDocsDeclaration declaration)	Creates an instance of a DeclaredPlugin record class.

Method Summary

Modifier and Type	Method	Description
GradlePluginCoordinate	coordinate()	Returns the value of the coordinate record component.
AgentDocsDeclaration	declaration()	Returns the value of the declaration record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
Path	jarPath()	Returns the value of the jarPath record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

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

Constructor Details

DeclaredPlugin

public DeclaredPlugin(GradlePluginCoordinate coordinate,
 Path jarPath,
 AgentDocsDeclaration declaration)

Creates an instance of a DeclaredPlugin record class.

Parameters:

coordinate - the value for the coordinate record component

jarPath - the value for the jarPath record component

declaration - the value for the declaration record component

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

coordinate

public GradlePluginCoordinate coordinate()

Returns the value of the coordinate record component.

Returns:

the value of the coordinate record component

jarPath

public Path jarPath()

Returns the value of the jarPath record component.

Returns:

the value of the jarPath record component

declaration

public AgentDocsDeclaration declaration()

Returns the value of the declaration record component.

Returns:

the value of the declaration record component