Package org.sonar.plugins.python.indexer

Record Class PackageResolutionResult

java.lang.Object

java.lang.Record

org.sonar.plugins.python.indexer.PackageResolutionResult

Record Components:

roots - The resolved package root absolute paths

method - The method used to resolve the package roots

buildSystem - The build system identified (only applicable for PYPROJECT_TOML method)

public record PackageResolutionResult(List<String> roots, PackageResolutionResult.ResolutionMethod method, PackageResolutionResult.BuildSystem buildSystem)
extends Record

Result of package root resolution containing both the resolved roots and information about how they were resolved.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	PackageResolutionResult.BuildSystem	Build systems supported in pyproject.toml.
static enum	PackageResolutionResult.ResolutionMethod	How the package roots were resolved.

Constructor Summary

Constructors

Constructor	Description
PackageResolutionResult(List<String> roots, PackageResolutionResult.ResolutionMethod method, PackageResolutionResult.BuildSystem buildSystem)	Creates an instance of a PackageResolutionResult record class.

Method Summary

Modifier and Type	Method	Description
PackageResolutionResult.BuildSystem	buildSystem()	Returns the value of the buildSystem record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
static PackageResolutionResult	fromBaseDir(List<String> roots)
static PackageResolutionResult	fromBothPyProjectAndSetupPy(List<String> roots, PackageResolutionResult.BuildSystem buildSystem)
static PackageResolutionResult	fromConventionalFolders(List<String> roots)
static PackageResolutionResult	fromLegacyInitPy()
static PackageResolutionResult	fromPyProjectToml(List<String> roots, PackageResolutionResult.BuildSystem buildSystem)
static PackageResolutionResult	fromSetupPy(List<String> roots)
static PackageResolutionResult	fromSonarSources(List<String> roots)
final int	hashCode()	Returns a hash code value for this object.
PackageResolutionResult.ResolutionMethod	method()	Returns the value of the method record component.
List<String>	roots()	Returns the value of the roots 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

PackageResolutionResult

public PackageResolutionResult(List<String> roots,
 PackageResolutionResult.ResolutionMethod method,
 PackageResolutionResult.BuildSystem buildSystem)

Creates an instance of a PackageResolutionResult record class.

Parameters:

roots - the value for the roots record component

method - the value for the method record component

buildSystem - the value for the buildSystem record component

Method Details

fromPyProjectToml

public static PackageResolutionResult fromPyProjectToml(List<String> roots,
 PackageResolutionResult.BuildSystem buildSystem)

fromSetupPy

public static PackageResolutionResult fromSetupPy(List<String> roots)

fromBothPyProjectAndSetupPy

public static PackageResolutionResult fromBothPyProjectAndSetupPy(List<String> roots,
 PackageResolutionResult.BuildSystem buildSystem)

fromSonarSources

public static PackageResolutionResult fromSonarSources(List<String> roots)

fromConventionalFolders

public static PackageResolutionResult fromConventionalFolders(List<String> roots)

fromBaseDir

public static PackageResolutionResult fromBaseDir(List<String> roots)

fromLegacyInitPy

public static PackageResolutionResult fromLegacyInitPy()

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.

roots

public List<String> roots()

Returns the value of the roots record component.

Returns:

the value of the roots record component

method

public PackageResolutionResult.ResolutionMethod method()

Returns the value of the method record component.

Returns:

the value of the method record component

buildSystem

public PackageResolutionResult.BuildSystem buildSystem()

Returns the value of the buildSystem record component.

Returns:

the value of the buildSystem record component