Package org.sonar.plugins.python.indexer

Record Class PyProjectExtractionResult

java.lang.Object

java.lang.Record

org.sonar.plugins.python.indexer.PyProjectExtractionResult

Record Components:

configRoots - The extracted source roots

buildSystem - The build system that provided the source roots

public record PyProjectExtractionResult(ConfigSourceRoots configRoots, PackageResolutionResult.BuildSystem buildSystem)
extends Record

Result of extracting source roots from pyproject.toml, including the build system detected.

Constructor Summary

Constructors

Constructor	Description
PyProjectExtractionResult(ConfigSourceRoots configRoots, PackageResolutionResult.BuildSystem buildSystem)	Creates an instance of a PyProjectExtractionResult record class.

Method Summary

Modifier and Type	Method	Description
PackageResolutionResult.BuildSystem	buildSystem()	Returns the value of the buildSystem record component.
ConfigSourceRoots	configRoots()	Returns the value of the configRoots record component.
static PyProjectExtractionResult	empty(File file)
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.
boolean	hasRoots()
List<String>	relativeRoots()
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

PyProjectExtractionResult

public PyProjectExtractionResult(ConfigSourceRoots configRoots,
 PackageResolutionResult.BuildSystem buildSystem)

Creates an instance of a PyProjectExtractionResult record class.

Parameters:

configRoots - the value for the configRoots record component

buildSystem - the value for the buildSystem record component

Method Details

empty

public static PyProjectExtractionResult empty(File file)

hasRoots

public boolean hasRoots()

relativeRoots

public List<String> relativeRoots()

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.

configRoots

public ConfigSourceRoots configRoots()

Returns the value of the configRoots record component.

Returns:

the value of the configRoots record component

buildSystem

public PackageResolutionResult.BuildSystem buildSystem()

Returns the value of the buildSystem record component.

Returns:

the value of the buildSystem record component