Package org.sonar.python.checks.utils

Record Class FunctionParameterUtils.FunctionParameterInfo

java.lang.Object

java.lang.Record

org.sonar.python.checks.utils.FunctionParameterUtils.FunctionParameterInfo

Enclosing class:

FunctionParameterUtils

public static record FunctionParameterUtils.FunctionParameterInfo(Set<String> allParams, Set<String> positionalOnlyParams, boolean hasVariadicKeyword)
extends Record

Information about a function's parameters for path/URL parameter checks.

Constructor Summary

Constructors

Constructor	Description
FunctionParameterInfo(Set<String> allParams, Set<String> positionalOnlyParams, boolean hasVariadicKeyword)	Creates an instance of a FunctionParameterInfo record class.

Method Summary

Modifier and Type	Method	Description
Set<String>	allParams()	Returns the value of the allParams record component.
static FunctionParameterUtils.FunctionParameterInfo	empty()
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	hasVariadicKeyword()	Returns the value of the hasVariadicKeyword record component.
boolean	isMissingFromSignature(String param)
Set<String>	positionalOnlyParams()	Returns the value of the positionalOnlyParams 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

FunctionParameterInfo

public FunctionParameterInfo(Set<String> allParams,
 Set<String> positionalOnlyParams,
 boolean hasVariadicKeyword)

Creates an instance of a FunctionParameterInfo record class.

Parameters:

allParams - the value for the allParams record component

positionalOnlyParams - the value for the positionalOnlyParams record component

hasVariadicKeyword - the value for the hasVariadicKeyword record component

Method Details

empty

public static FunctionParameterUtils.FunctionParameterInfo empty()

isMissingFromSignature

public boolean isMissingFromSignature(String param)

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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.

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.

allParams

public Set<String> allParams()

Returns the value of the allParams record component.

Returns:

the value of the allParams record component

positionalOnlyParams

public Set<String> positionalOnlyParams()

Returns the value of the positionalOnlyParams record component.

Returns:

the value of the positionalOnlyParams record component

hasVariadicKeyword

public boolean hasVariadicKeyword()

Returns the value of the hasVariadicKeyword record component.

Returns:

the value of the hasVariadicKeyword record component