Package com.intellij.psi.util

Class PropertyUtilBase

java.lang.Object

com.intellij.psi.util.PropertyUtilBase

Direct Known Subclasses:

PropertyUtil

public class PropertyUtilBase
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PropertyUtilBase.GetterFlavour

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	GET_PREFIX
protected static java.lang.String	IS_PREFIX
protected static java.lang.String	SET_PREFIX

Constructor Summary

Constructors

Constructor and Description
PropertyUtilBase()

Method Summary

Modifier and Type	Method and Description
static PsiMethod	findGetterForField(PsiField field)
static PsiField	findPropertyField(PsiClass aClass, java.lang.String propertyName, boolean isStatic)
static PsiField	findPropertyFieldByMember(PsiMember psiMember)
static PsiMethod	findPropertyGetter(PsiClass aClass, java.lang.String propertyName, boolean isStatic, boolean checkSuperClasses)
static PsiMethod	findPropertyGetterWithType(java.lang.String propertyName, boolean isStatic, PsiType type, java.util.Collection<? extends PsiMethod> methods)
static PsiMethod	findPropertySetter(PsiClass aClass, java.lang.String propertyName, boolean isStatic, boolean checkSuperClasses)
static PsiMethod	findPropertySetterWithType(java.lang.String propertyName, boolean isStatic, PsiType type, java.util.Collection<? extends PsiMethod> methods)
static PsiMethod	findSetterForField(PsiField field)
static PsiMethod	generateGetterPrototype(PsiField field) Consider using GenerateMembersUtil.generateGetterPrototype(PsiField) or GenerateMembersUtil.generateSimpleGetterPrototype(PsiField) to add @Override annotation
static PsiMethod	generateSetterPrototype(PsiField field) Consider using GenerateMembersUtil.generateSetterPrototype(PsiField) or GenerateMembersUtil.generateSimpleSetterPrototype(PsiField) to add @Override annotation
static PsiMethod	generateSetterPrototype(PsiField field, PsiClass containingClass) Consider using GenerateMembersUtil.generateSetterPrototype(PsiField) or GenerateMembersUtil.generateSimpleSetterPrototype(PsiField) to add @Override annotation
static PsiMethod	generateSetterPrototype(PsiField field, PsiClass containingClass, boolean returnSelf) Consider using GenerateMembersUtil.generateSetterPrototype(PsiField) or GenerateMembersUtil.generateSimpleSetterPrototype(PsiField) to add @Override annotation
static java.lang.String	getAccessorName(java.lang.String propertyName, PropertyKind kind)
static java.util.List<PsiMethod>	getAccessors(PsiClass psiClass, java.lang.String propertyName)
static java.util.Map<java.lang.String,PsiMethod>	getAllProperties(boolean acceptSetters, boolean acceptGetters, PsiMethod[] methods)
static java.util.Map<java.lang.String,PsiMethod>	getAllProperties(PsiClass psiClass, boolean acceptSetters, boolean acceptGetters)
static java.util.Map<java.lang.String,PsiMethod>	getAllProperties(PsiClass psiClass, boolean acceptSetters, boolean acceptGetters, boolean includeSuperClass)
static PsiExpression	getGetterReturnExpression(PsiMethod method) If the name of the method looks like a getter and the body consists of a single return statement, returns the returned expression.
static java.util.List<PsiMethod>	getGetters(PsiClass psiClass, java.lang.String propertyName)
static PropertyUtilBase.GetterFlavour	getMethodNameGetterFlavour(java.lang.String methodName)
static PropertyKind	getPropertyKind(java.lang.String accessorName)
static java.lang.String	getPropertyName(PsiMember member)
static java.lang.String	getPropertyName(PsiMethod method)
static java.lang.String	getPropertyName(java.lang.String methodName)
static Pair<java.lang.String,PropertyKind>	getPropertyNameAndKind(java.lang.String accessorName)
static java.lang.String	getPropertyNameByGetter(PsiMethod getterMethod)
static java.lang.String	getPropertyNameBySetter(PsiMethod setterMethod)
static PsiIdentifier	getPropertyNameIdentifier(PsiMember member)
static PsiType	getPropertyType(PsiMember member)
static PsiTypeElement	getPropertyTypeElement(PsiMember member)
static java.lang.String []	getReadableProperties(PsiClass aClass, boolean includeSuperClass)
static java.util.List<PsiMethod>	getSetters(PsiClass psiClass, java.lang.String propertyName)
static PsiExpression	getSingleReturnValue(PsiMethod method)
static java.lang.String []	getWritableProperties(PsiClass aClass, boolean includeSuperClass)
static boolean	hasGetterName(PsiMethod method)
static boolean	isSetterName(java.lang.String methodName)
static boolean	isSimplePropertyAccessor(PsiMethod method)
static boolean	isSimplePropertyGetter(PsiMethod method)
static boolean	isSimplePropertySetter(PsiMethod method)
static java.lang.String	suggestGetterName(PsiField field)
static java.lang.String	suggestGetterName(java.lang.String propertyName, PsiType propertyType)
static java.lang.String	suggestGetterName(java.lang.String propertyName, PsiType propertyType, java.lang.String existingGetterName)
static java.lang.String []	suggestGetterNames(java.lang.String propertyName)
static java.lang.String	suggestPropertyName(PsiField field)
static java.lang.String	suggestPropertyName(PsiField field, java.lang.String fieldName)
static java.lang.String	suggestSetterName(PsiField field)
static java.lang.String	suggestSetterName(java.lang.String propertyName)
static java.lang.String	suggestSetterName(java.lang.String propertyName, java.lang.String setterPrefix)

Methods inherited from class java.lang.Object

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

Field Detail

GET_PREFIX

protected static final java.lang.String GET_PREFIX

IS_PREFIX

protected static final java.lang.String IS_PREFIX

SET_PREFIX

protected static final java.lang.String SET_PREFIX

Constructor Detail

PropertyUtilBase

public PropertyUtilBase()

Method Detail

getPropertyName

public static java.lang.String getPropertyName(java.lang.String methodName)

getAllProperties

public static java.util.Map<java.lang.String,PsiMethod> getAllProperties(PsiClass psiClass,
                                                                         boolean acceptSetters,
                                                                         boolean acceptGetters)

getAllProperties

public static java.util.Map<java.lang.String,PsiMethod> getAllProperties(PsiClass psiClass,
                                                                         boolean acceptSetters,
                                                                         boolean acceptGetters,
                                                                         boolean includeSuperClass)

getAllProperties

public static java.util.Map<java.lang.String,PsiMethod> getAllProperties(boolean acceptSetters,
                                                                         boolean acceptGetters,
                                                                         PsiMethod[] methods)

getSetters

public static java.util.List<PsiMethod> getSetters(PsiClass psiClass,
                                                   java.lang.String propertyName)

getGetters

public static java.util.List<PsiMethod> getGetters(PsiClass psiClass,
                                                   java.lang.String propertyName)

getAccessors

public static java.util.List<PsiMethod> getAccessors(PsiClass psiClass,
                                                     java.lang.String propertyName)

getReadableProperties

public static java.lang.String [] getReadableProperties(PsiClass aClass,
                                                        boolean includeSuperClass)

getWritableProperties

public static java.lang.String [] getWritableProperties(PsiClass aClass,
                                                        boolean includeSuperClass)

getPropertyType

public static PsiType getPropertyType(PsiMember member)

findPropertySetter

public static PsiMethod findPropertySetter(PsiClass aClass,
                                           java.lang.String propertyName,
                                           boolean isStatic,
                                           boolean checkSuperClasses)

findPropertyField

public static PsiField findPropertyField(PsiClass aClass,
                                         java.lang.String propertyName,
                                         boolean isStatic)

findPropertyGetter

public static PsiMethod findPropertyGetter(PsiClass aClass,
                                           java.lang.String propertyName,
                                           boolean isStatic,
                                           boolean checkSuperClasses)

findPropertyGetterWithType

public static PsiMethod findPropertyGetterWithType(java.lang.String propertyName,
                                                   boolean isStatic,
                                                   PsiType type,
                                                   java.util.Collection<? extends PsiMethod> methods)

isSimplePropertyAccessor

public static boolean isSimplePropertyAccessor(PsiMethod method)

findPropertySetterWithType

public static PsiMethod findPropertySetterWithType(java.lang.String propertyName,
                                                   boolean isStatic,
                                                   PsiType type,
                                                   java.util.Collection<? extends PsiMethod> methods)

getMethodNameGetterFlavour

public static PropertyUtilBase.GetterFlavour getMethodNameGetterFlavour(java.lang.String methodName)

isSimplePropertyGetter

public static boolean isSimplePropertyGetter(PsiMethod method)

hasGetterName

public static boolean hasGetterName(PsiMethod method)

suggestPropertyName

public static java.lang.String suggestPropertyName(PsiField field)

suggestPropertyName

public static java.lang.String suggestPropertyName(PsiField field,
                                                   java.lang.String fieldName)

suggestGetterName

public static java.lang.String suggestGetterName(PsiField field)

suggestSetterName

public static java.lang.String suggestSetterName(PsiField field)

getPropertyName

public static java.lang.String getPropertyName(PsiMember member)

isSimplePropertySetter

public static boolean isSimplePropertySetter(PsiMethod method)

isSetterName

public static boolean isSetterName(java.lang.String methodName)

getPropertyName

public static java.lang.String getPropertyName(PsiMethod method)

getPropertyNameByGetter

public static java.lang.String getPropertyNameByGetter(PsiMethod getterMethod)

getPropertyNameBySetter

public static java.lang.String getPropertyNameBySetter(PsiMethod setterMethod)

suggestGetterNames

public static java.lang.String [] suggestGetterNames(java.lang.String propertyName)

suggestGetterName

public static java.lang.String suggestGetterName(java.lang.String propertyName,
                                                 PsiType propertyType)

suggestGetterName

public static java.lang.String suggestGetterName(java.lang.String propertyName,
                                                 PsiType propertyType,
                                                 java.lang.String existingGetterName)

suggestSetterName

public static java.lang.String suggestSetterName(java.lang.String propertyName)

suggestSetterName

public static java.lang.String suggestSetterName(java.lang.String propertyName,
                                                 java.lang.String setterPrefix)

generateGetterPrototype

public static PsiMethod generateGetterPrototype(PsiField field)

Consider using GenerateMembersUtil.generateGetterPrototype(PsiField) or GenerateMembersUtil.generateSimpleGetterPrototype(PsiField) to add @Override annotation

generateSetterPrototype

public static PsiMethod generateSetterPrototype(PsiField field)

Consider using GenerateMembersUtil.generateSetterPrototype(PsiField) or GenerateMembersUtil.generateSimpleSetterPrototype(PsiField) to add @Override annotation

generateSetterPrototype

public static PsiMethod generateSetterPrototype(PsiField field,
                                                PsiClass containingClass)

Consider using GenerateMembersUtil.generateSetterPrototype(PsiField) or GenerateMembersUtil.generateSimpleSetterPrototype(PsiField) to add @Override annotation

generateSetterPrototype

public static PsiMethod generateSetterPrototype(PsiField field,
                                                PsiClass containingClass,
                                                boolean returnSelf)

Consider using GenerateMembersUtil.generateSetterPrototype(PsiField) or GenerateMembersUtil.generateSimpleSetterPrototype(PsiField) to add @Override annotation

getPropertyTypeElement

public static PsiTypeElement getPropertyTypeElement(PsiMember member)

getPropertyNameIdentifier

public static PsiIdentifier getPropertyNameIdentifier(PsiMember member)

findPropertyFieldByMember

public static PsiField findPropertyFieldByMember(PsiMember psiMember)

findSetterForField

public static PsiMethod findSetterForField(PsiField field)

findGetterForField

public static PsiMethod findGetterForField(PsiField field)

getGetterReturnExpression

public static PsiExpression getGetterReturnExpression(PsiMethod method)

If the name of the method looks like a getter and the body consists of a single return statement, returns the returned expression. Otherwise, returns null.

Parameters:

method - the method to check

Returns:

the return value, or null if it doesn't match the conditions.

getSingleReturnValue

public static PsiExpression getSingleReturnValue(PsiMethod method)

getPropertyKind

public static PropertyKind getPropertyKind(java.lang.String accessorName)

getPropertyNameAndKind

public static Pair<java.lang.String,PropertyKind> getPropertyNameAndKind(java.lang.String accessorName)

See Also:

StringUtil.getPropertyName(String), Introspector

getAccessorName

public static java.lang.String getAccessorName(java.lang.String propertyName,
                                               PropertyKind kind)