Package com.intellij.psi.util

Class JavaPsiRecordUtil

java.lang.Object

com.intellij.psi.util.JavaPsiRecordUtil

public class JavaPsiRecordUtil
extends java.lang.Object

Utility methods to support Java records

Constructor Summary

Constructors

Constructor and Description
JavaPsiRecordUtil()

Method Summary

Modifier and Type	Method and Description
static PsiMethod	findCanonicalConstructor(PsiClass recordClass)
static PsiRecordComponent	getComponentForField(PsiField field)
static PsiField	getFieldForComponent(PsiRecordComponent component)
static PsiRecordComponent	getRecordComponentForAccessor(PsiMethod accessor)
static boolean	isCompactConstructor(PsiMethod method)
static boolean	isExplicitCanonicalConstructor(PsiMethod method)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JavaPsiRecordUtil

public JavaPsiRecordUtil()

Method Detail

getRecordComponentForAccessor

public static PsiRecordComponent getRecordComponentForAccessor(PsiMethod accessor)

Parameters:

accessor - accessor method for record component

Returns:

a corresponding record component, or null if the supplied method is not an accessor for the record component. Note that if accessor is not well-formed (e.g. has wrong return type), the corresponding record component will still be returned.

getFieldForComponent

public static PsiField getFieldForComponent(PsiRecordComponent component)

Parameters:

component - record component

Returns:

synthetic field that corresponds to given component, or null if not found (e.g. if this component doesn't belong to a class)

getComponentForField

public static PsiRecordComponent getComponentForField(PsiField field)

Parameters:

field - synthetic field that corresponds to the record component

Returns:

the corresponding record component; null if given field doesn't correspond to the record component.

isCompactConstructor

public static boolean isCompactConstructor(PsiMethod method)

Parameters:

method - method to check

Returns:

true if given method is a compact constructor (has no parameter list), regardless whether it's declared in the record or not

isExplicitCanonicalConstructor

public static boolean isExplicitCanonicalConstructor(PsiMethod method)

Parameters:

method - method to check

Returns:

true if given method is an explicit canonical (non-compact) constructor for a record class

findCanonicalConstructor

public static PsiMethod findCanonicalConstructor(PsiClass recordClass)

Parameters:

recordClass - record class

Returns:

first explicitly declared canonical or compact constructor; null if the supplied class is not a record. Returns a synthetic constructor if it's not explicitly defined.