Package org.sonar.plugins.php.api.visitors

Record Class PhpInputFileContext

java.lang.Object

java.lang.Record

org.sonar.plugins.php.api.visitors.PhpInputFileContext

public record PhpInputFileContext(PhpFile phpFile, @Nullable File workingDirectory, @Nullable CacheContext cacheContext)
extends Record

Constructor Summary

Constructors

Constructor	Description
PhpInputFileContext(PhpFile phpFile, File workingDirectory, CacheContext cacheContext)	Creates an instance of a PhpInputFileContext record class.

Method Summary

Modifier and Type	Method	Description
CacheContext	cacheContext()	Returns the value of the cacheContext 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.
PhpFile	phpFile()	Returns the value of the phpFile record component.
final String	toString()	Returns a string representation of this record class.
File	workingDirectory()	Returns the value of the workingDirectory record component.

Methods inherited from class java.lang.Object

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

Constructor Details

PhpInputFileContext

public PhpInputFileContext(PhpFile phpFile,
 @Nullable
 File workingDirectory,
 @Nullable
 CacheContext cacheContext)

Creates an instance of a PhpInputFileContext record class.

Parameters:

phpFile - the value for the phpFile record component

workingDirectory - the value for the workingDirectory record component

cacheContext - the value for the cacheContext record component

Method Details

workingDirectory

@CheckForNull
public File workingDirectory()

Returns the value of the workingDirectory record component.

Returns:

the value of the workingDirectory record component

cacheContext

@CheckForNull
public CacheContext cacheContext()

Returns the value of the cacheContext record component.

Returns:

the value of the cacheContext record component

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.

phpFile

public PhpFile phpFile()

Returns the value of the phpFile record component.

Returns:

the value of the phpFile record component