public class LightMethodBuilder extends LightElement implements PsiMethod, OriginInfoAwareElement
Iconable.IconFlags, Iconable.LastComputedIconmyManagerFLAGS_LOCKED, ICON_PLACEHOLDERARRAY_FACTORY, EMPTY_ARRAYEMPTY_NAVIGATABLE_ELEMENT_ARRAYEMPTY_NAVIGATION_ITEM_ARRAYICON_FLAG_IGNORE_MASK, ICON_FLAG_OPEN, ICON_FLAG_READ_STATUS, ICON_FLAG_VISIBILITY| Constructor and Description |
|---|
LightMethodBuilder(PsiClass constructedClass,
Language language) |
LightMethodBuilder(PsiManager manager,
Language language,
java.lang.String name) |
LightMethodBuilder(PsiManager manager,
Language language,
java.lang.String name,
PsiParameterList parameterList,
PsiModifierList modifierList) |
LightMethodBuilder(PsiManager manager,
Language language,
java.lang.String name,
PsiParameterList parameterList,
PsiModifierList modifierList,
PsiReferenceList throwsList,
PsiTypeParameterList typeParameterList) |
LightMethodBuilder(PsiManager manager,
java.lang.String name) |
| Modifier and Type | Method and Description |
|---|---|
void |
accept(PsiElementVisitor visitor)
Passes the element to the specified visitor.
|
LightMethodBuilder |
addException(PsiClassType type) |
LightMethodBuilder |
addException(java.lang.String fqName) |
LightMethodBuilder |
addModifier(java.lang.String modifier) |
LightMethodBuilder |
addModifiers(java.lang.String... modifiers) |
LightMethodBuilder |
addParameter(PsiParameter parameter) |
LightMethodBuilder |
addParameter(java.lang.String name,
PsiType type) |
LightMethodBuilder |
addParameter(java.lang.String name,
PsiType type,
boolean isVarArgs) |
LightMethodBuilder |
addParameter(java.lang.String name,
java.lang.String type) |
LightMethodBuilder |
addTypeParameter(PsiTypeParameter parameter) |
boolean |
equals(java.lang.Object o) |
PsiMethod |
findDeepestSuperMethod()
Returns the method in the deepest base superclass or interface of the containing class which
this method overrides or implements.
|
PsiMethod [] |
findDeepestSuperMethods() |
PsiMethod [] |
findSuperMethods()
Searches the superclasses and base interfaces of the containing class to find
the methods which this method overrides or implements.
|
PsiMethod [] |
findSuperMethods(boolean checkAccess)
Searches the superclasses and base interfaces of the containing class to find
the methods which this method overrides or implements, optionally omitting
the accessibility check.
|
PsiMethod [] |
findSuperMethods(PsiClass parentClass)
Searches the superclasses and base interfaces of the specified class to find
the methods which this method can override or implement.
|
java.util.List<MethodSignatureBackedByPsiMethod> |
findSuperMethodSignaturesIncludingStatic(boolean checkAccess)
Searches the superclasses and base interfaces of the containing class to find
static and instance methods with the signature matching the signature of this method.
|
PsiCodeBlock |
getBody()
Returns the body of the method.
|
PsiClass |
getContainingClass()
Returns the class containing the member.
|
PsiFile |
getContainingFile()
Returns the file containing the PSI element.
|
PsiElement |
getContext()
Returns the element which should be used as the parent of this element in a tree up
walk during a resolve operation.
|
PsiDocComment |
getDocComment()
Returns the JavaDoc comment for the element, or
null when the element has no JavaDoc comment. |
javax.swing.Icon |
getElementIcon(int flags) |
HierarchicalMethodSignature |
getHierarchicalMethodSignature() |
PsiModifierList |
getModifierList()
Returns the list of modifiers for the element.
|
java.lang.String |
getName()
Returns the name of the element.
|
PsiIdentifier |
getNameIdentifier()
Returns the name identifier for the method.
|
java.lang.String |
getOriginInfo() |
PsiParameterList |
getParameterList()
Returns the parameter list for the method.
|
ItemPresentation |
getPresentation() |
PsiType |
getReturnType()
Returns the return type of the method.
|
PsiTypeElement |
getReturnTypeElement()
Returns the type element for the return type of the method.
|
MethodSignature |
getSignature(PsiSubstitutor substitutor)
Returns the signature of this method, using the specified substitutor to specify
values of generic type parameters.
|
PsiReferenceList |
getThrowsList()
Returns the list of thrown exceptions for the method.
|
PsiTypeParameterList |
getTypeParameterList()
Returns the type parameter list for the element.
|
PsiTypeParameter [] |
getTypeParameters()
Returns the array of type parameters for the element.
|
SearchScope |
getUseScope()
Returns the scope in which references to this element are searched.
|
int |
hashCode() |
boolean |
hasModifierProperty(java.lang.String name)
Checks if the element has the specified modifier.
|
boolean |
hasTypeParameters()
Checks if the element has any type parameters.
|
boolean |
isConstructor()
Checks if the method is a constructor.
|
boolean |
isDeprecated()
Returns
true if the element is marked as deprecated via an annotation or a JavaDoc tag. |
boolean |
isEquivalentTo(PsiElement another)
This method shouldn't be called by clients directly, because there are no guarantees of it being symmetric.
|
boolean |
isVarArgs()
Checks if the method accepts a variable number of arguments.
|
protected boolean |
isVisibilitySupported() |
LightMethodBuilder |
setBaseIcon(javax.swing.Icon baseIcon) |
LightMethodBuilder |
setConstructor(boolean constructor) |
LightMethodBuilder |
setContainingClass(PsiClass containingClass) |
LightMethodBuilder |
setMethodKind(java.lang.String debugKindName) |
LightMethodBuilder |
setMethodReturnType(Computable<? extends PsiType> returnType) |
LightMethodBuilder |
setMethodReturnType(PsiType returnType) |
LightMethodBuilder |
setMethodReturnType(java.lang.String returnType) |
LightMethodBuilder |
setModifiers(java.lang.String... modifiers) |
PsiElement |
setName(java.lang.String name)
Renames the element.
|
void |
setOriginInfo(java.lang.String originInfo) |
java.lang.String |
toString()
toString() should never be presented to the user.
|
add, addAfter, addBefore, checkAdd, checkDelete, copy, delete, findElementAt, getChildren, getLanguage, getManager, getNavigationElement, getNextSibling, getNode, getParent, getPrevSibling, getStartOffsetInParent, getText, getTextLength, getTextOffset, getTextRange, isPhysical, isValid, isWritable, replace, setNavigationElement, textMatches, textMatches, textToCharArrayacceptChildren, addRange, addRangeAfter, addRangeBefore, canNavigate, canNavigateToSource, deleteChildRange, findChildByClass, findChildrenByClass, findNotNullChildByClass, findReferenceAt, getFirstChild, getLastChild, getOriginalElement, getProject, getReference, getReferences, getResolveScope, navigate, notNullChild, processDeclarations, textContainsbuildRowIcon, computeBaseIcon, createLayeredIcon, getAdjustedBaseIcon, getBaseIcon, getIcon, iconWithVisibilityIfNeeded, isNativeFileType, overlayIcons, registerIconLayer, transformFlagschangeUserMap, clearUserData, clone, copyCopyableDataTo, copyUserDataTo, getCopyableUserData, getUserData, getUserDataString, getUserMap, isUserDataEmpty, putCopyableUserData, putUserData, putUserDataIfAbsent, replace, setUserMapfinalize, getClass, notify, notifyAll, wait, wait, waitgetParameters, getThrowsTypes, hasParametersgetIdentifyingElementcanNavigate, canNavigateToSource, navigategetAnnotation, getAnnotations, getSourceElement, hasAnnotation, hasModifieracceptChildren, add, addAfter, addBefore, addRange, addRangeAfter, addRangeBefore, checkAdd, checkDelete, copy, delete, deleteChildRange, findElementAt, findReferenceAt, getChildren, getCopyableUserData, getFirstChild, getLanguage, getLastChild, getManager, getNavigationElement, getNextSibling, getNode, getOriginalElement, getOwnReferences, getParent, getPrevSibling, getProject, getReference, getReferences, getResolveScope, getStartOffsetInParent, getText, getTextLength, getTextOffset, getTextRange, getTextRangeInParent, isPhysical, isValid, isWritable, processDeclarations, putCopyableUserData, replace, textContains, textMatches, textMatches, textToCharArraygetUserData, putUserDataisWritablegetNavigationElementpublic LightMethodBuilder(PsiManager manager, java.lang.String name)
public LightMethodBuilder(PsiManager manager, Language language, java.lang.String name)
public LightMethodBuilder(PsiManager manager, Language language, java.lang.String name, PsiParameterList parameterList, PsiModifierList modifierList)
public LightMethodBuilder(PsiManager manager, Language language, java.lang.String name, PsiParameterList parameterList, PsiModifierList modifierList, PsiReferenceList throwsList, PsiTypeParameterList typeParameterList)
public ItemPresentation getPresentation()
getPresentation in interface NavigationItemgetPresentation in class PsiElementBasepublic boolean hasTypeParameters()
PsiTypeParameterListOwnerhasTypeParameters in interface PsiTypeParameterListOwnerpublic PsiTypeParameter [] getTypeParameters()
PsiTypeParameterListOwnergetTypeParameters in interface JvmTypeParametersOwnergetTypeParameters in interface PsiTypeParameterListOwnerGenericDeclaration.getTypeParameters()public PsiTypeParameterList getTypeParameterList()
PsiTypeParameterListOwnergetTypeParameterList in interface PsiTypeParameterListOwnerpublic PsiDocComment getDocComment()
PsiJavaDocumentedElementnull when the element has no JavaDoc comment.getDocComment in interface PsiJavaDocumentedElementpublic boolean isDeprecated()
PsiDocCommentOwnertrue if the element is marked as deprecated via an annotation or a JavaDoc tag.isDeprecated in interface PsiDocCommentOwnerpublic PsiElement setName(java.lang.String name) throws IncorrectOperationException
PsiNamedElementsetName in interface PomRenameableTarget<PsiElement>setName in interface PsiMethodsetName in interface PsiNamedElementname - the new element name.this
or a different element if the rename caused the element to be replaced).IncorrectOperationException - if the modification is not supported or not possible for some reason.public java.lang.String getName()
PsiNamedElementgetName in interface JvmMembergetName in interface JvmMethodgetName in interface JvmNamedElementgetName in interface NavigationItemgetName in interface PomNamedTargetgetName in interface PsiMethodgetName in interface PsiNamedElementgetName in class PsiElementBaseMember.getName()public HierarchicalMethodSignature getHierarchicalMethodSignature()
getHierarchicalMethodSignature in interface PsiMethodpublic boolean hasModifierProperty(java.lang.String name)
PsiModifierListOwnerPsiModifier class.hasModifierProperty in interface PsiModifierListOwnername - the name of the modifier to check.public PsiModifierList getModifierList()
PsiModifierListOwnergetModifierList in interface PsiMethodgetModifierList in interface PsiModifierListOwnerpublic LightMethodBuilder addModifiers(java.lang.String... modifiers)
public LightMethodBuilder addModifier(java.lang.String modifier)
public LightMethodBuilder setModifiers(java.lang.String... modifiers)
public PsiType getReturnType()
PsiMethodgetReturnType in interface JvmMethodgetReturnType in interface PsiMethodMethod.getGenericReturnType(),
Method.getAnnotatedReturnType()public LightMethodBuilder setMethodReturnType(Computable<? extends PsiType> returnType)
public LightMethodBuilder setMethodReturnType(PsiType returnType)
public LightMethodBuilder setMethodReturnType(java.lang.String returnType)
public PsiTypeElement getReturnTypeElement()
PsiMethodgetReturnTypeElement in interface PsiMethodpublic PsiParameterList getParameterList()
PsiMethodgetParameterList in interface PsiMethodgetParameterList in interface PsiParameterListOwnerpublic LightMethodBuilder addParameter(PsiParameter parameter)
public LightMethodBuilder addParameter(java.lang.String name, java.lang.String type)
public LightMethodBuilder addParameter(java.lang.String name, PsiType type)
public LightMethodBuilder addParameter(java.lang.String name, PsiType type, boolean isVarArgs)
public LightMethodBuilder addException(PsiClassType type)
public LightMethodBuilder addException(java.lang.String fqName)
public PsiReferenceList getThrowsList()
PsiMethodgetThrowsList in interface PsiMethodpublic PsiCodeBlock getBody()
PsiMethodgetBody in interface PsiMethodgetBody in interface PsiParameterListOwnerpublic LightMethodBuilder setConstructor(boolean constructor)
public boolean isConstructor()
PsiMethodisConstructor in interface JvmMethodisConstructor in interface PsiMethodpublic boolean isVarArgs()
PsiMethodpublic MethodSignature getSignature(PsiSubstitutor substitutor)
PsiMethodgetSignature in interface PsiMethodsubstitutor - the substitutor.public PsiIdentifier getNameIdentifier()
PsiMethodgetNameIdentifier in interface PsiMethodgetNameIdentifier in interface PsiNameIdentifierOwnerpublic PsiMethod [] findSuperMethods()
PsiMethodfindSuperMethods in interface PsiMethodpublic PsiMethod [] findSuperMethods(boolean checkAccess)
PsiMethodfindSuperMethods in interface PsiMethodcheckAccess - if false, the super methods are searched even if this method
is private. If true, an empty result list is returned for private methods.public PsiMethod [] findSuperMethods(PsiClass parentClass)
PsiMethodfindSuperMethods in interface PsiMethodparentClass - the class to search for super methods.public java.util.List<MethodSignatureBackedByPsiMethod> findSuperMethodSignaturesIncludingStatic(boolean checkAccess)
PsiMethodfindSuperMethodSignaturesIncludingStatic in interface PsiMethodcheckAccess - if false, the super methods are searched even if this method
is private. If true, an empty result list is returned for private methods.public PsiMethod findDeepestSuperMethod()
PsiMethodfindDeepestSuperMethod in interface PsiMethodpublic PsiMethod [] findDeepestSuperMethods()
findDeepestSuperMethods in interface PsiMethodpublic void accept(PsiElementVisitor visitor)
PsiElementaccept in interface PsiElementaccept in class LightElementvisitor - the visitor to pass the element to.public PsiClass getContainingClass()
PsiMembergetContainingClass in interface JvmMembergetContainingClass in interface PsiJvmMembergetContainingClass in interface PsiMemberMember.getDeclaringClass()public LightMethodBuilder setContainingClass(PsiClass containingClass)
public LightMethodBuilder setMethodKind(java.lang.String debugKindName)
public java.lang.String toString()
PsiElementtoString in interface PsiElementtoString in class LightElementpublic javax.swing.Icon getElementIcon(int flags)
getElementIcon in class ElementBaseprotected boolean isVisibilitySupported()
isVisibilitySupported in class ElementBasepublic LightMethodBuilder setBaseIcon(javax.swing.Icon baseIcon)
public boolean isEquivalentTo(PsiElement another)
PsiElementPsiManager.areElementsEquivalent(PsiElement, PsiElement) internally, which clients should invoke instead.
Implementations of this method should return true if the parameter is resolve-equivalent to this, i.e. it represents
the same entity from the language perspective. See also PsiManager.areElementsEquivalent(PsiElement, PsiElement) documentation.isEquivalentTo in interface PsiElementisEquivalentTo in class PsiElementBasepublic SearchScope getUseScope()
PsiElementgetUseScope in interface PsiElementgetUseScope in class PsiElementBasePsiSearchHelper.getUseScope(PsiElement)public PsiFile getContainingFile()
PsiElementgetContainingFile in interface PsiElementgetContainingFile in class LightElementpublic PsiElement getContext()
PsiElementgetParent(),
but the context can be overridden for some elements like code fragments (see
JavaCodeFragmentFactory.createCodeBlockCodeFragment(String, PsiElement, boolean)).getContext in interface PsiElementgetContext in class PsiElementBasepublic boolean equals(java.lang.Object o)
equals in class java.lang.Objectpublic int hashCode()
hashCode in class java.lang.Objectpublic LightMethodBuilder addTypeParameter(PsiTypeParameter parameter)
public java.lang.String getOriginInfo()
getOriginInfo in interface OriginInfoAwareElementpublic void setOriginInfo(java.lang.String originInfo)