| /******************************************************************************* |
| * Copyright (c) 2005, 2011 Oracle. All rights reserved. |
| * This program and the accompanying materials are made available under the |
| * terms of the Eclipse Public License v1.0, which accompanies this distribution |
| * and is available at http://www.eclipse.org/legal/epl-v10.html. |
| * |
| * Contributors: |
| * Oracle - initial API and implementation |
| ******************************************************************************/ |
| package org.eclipse.jpt.common.core.internal.utility.jdt; |
| |
| import java.util.Arrays; |
| import java.util.List; |
| import org.eclipse.jdt.core.ICompilationUnit; |
| import org.eclipse.jdt.core.dom.CompilationUnit; |
| import org.eclipse.jdt.core.dom.IMethodBinding; |
| import org.eclipse.jdt.core.dom.ITypeBinding; |
| import org.eclipse.jdt.core.dom.MethodDeclaration; |
| import org.eclipse.jdt.core.dom.SingleVariableDeclaration; |
| import org.eclipse.jdt.core.dom.TypeDeclaration; |
| import org.eclipse.jpt.common.core.utility.TextRange; |
| import org.eclipse.jpt.common.core.utility.jdt.AnnotationEditFormatter; |
| import org.eclipse.jpt.common.core.utility.jdt.MethodAttribute; |
| import org.eclipse.jpt.common.core.utility.jdt.Type; |
| import org.eclipse.jpt.common.utility.CommandExecutor; |
| import org.eclipse.jpt.common.utility.JavaType; |
| import org.eclipse.jpt.common.utility.MethodSignature; |
| import org.eclipse.jpt.common.utility.internal.NameTools; |
| import org.eclipse.jpt.common.utility.internal.SimpleMethodSignature; |
| |
| /** |
| * Adapt and extend a JDT method. |
| * Attribute based on a Java property, e.g. |
| * private int getFoo() { |
| * return foo; |
| * } |
| * private void setFoo(int foo) { |
| * this.foo = foo; |
| * } |
| */ |
| public class JDTMethodAttribute |
| extends JDTMember |
| implements MethodAttribute |
| { |
| /** we need the parameter types to build the method signature */ |
| private final JavaType[] parameterTypes; |
| |
| |
| // ********** constructors ********** |
| |
| public static JDTMethodAttribute newInstance( |
| Type declaringType, |
| MethodSignature signature, |
| int occurrence, |
| ICompilationUnit compilationUnit, |
| CommandExecutor modifySharedDocumentCommandExecutor) { |
| return newInstance(declaringType, signature, occurrence, compilationUnit, modifySharedDocumentCommandExecutor, DefaultAnnotationEditFormatter.instance()); |
| } |
| |
| public static JDTMethodAttribute newInstance( |
| Type declaringType, |
| MethodSignature signature, |
| int occurrence, |
| ICompilationUnit compilationUnit, |
| CommandExecutor modifySharedDocumentCommandExecutor, |
| AnnotationEditFormatter annotationEditFormatter) { |
| return new JDTMethodAttribute(declaringType, signature, occurrence, compilationUnit, modifySharedDocumentCommandExecutor, annotationEditFormatter); |
| } |
| |
| private JDTMethodAttribute( |
| Type declaringType, |
| MethodSignature methodSignature, |
| int occurrence, |
| ICompilationUnit compilationUnit, |
| CommandExecutor modifySharedDocumentCommandExecutor, |
| AnnotationEditFormatter annotationEditFormatter) { |
| super(declaringType, methodSignature.getName(), occurrence, compilationUnit, modifySharedDocumentCommandExecutor, annotationEditFormatter); |
| this.parameterTypes = methodSignature.getParameterTypes(); |
| } |
| |
| /** |
| * constructor for testing |
| */ |
| public JDTMethodAttribute(Type declaringType, String name, String[] parameterTypeNames, int occurrence, ICompilationUnit compilationUnit) { |
| this(declaringType, new SimpleMethodSignature(name, parameterTypeNames), occurrence, compilationUnit, CommandExecutor.Default.instance(), DefaultAnnotationEditFormatter.instance()); |
| } |
| |
| |
| // ********** Member/Attribute/MethodAttribute implementation ********** |
| |
| @Override |
| protected Type getDeclaringType() { |
| return (Type) super.getDeclaringType(); |
| } |
| |
| public boolean isField() { |
| return false; |
| } |
| |
| public IMethodBinding getBinding(CompilationUnit astRoot) { |
| return this.getBodyDeclaration(astRoot).resolveBinding(); |
| } |
| |
| @Override |
| public MethodDeclaration getBodyDeclaration(CompilationUnit astRoot) { |
| int count = 0; |
| for (MethodDeclaration methodDeclaration : this.getDeclaringTypeMethodDeclarations(astRoot)) { |
| if (this.matches(methodDeclaration)) { |
| count++; |
| if (count == this.getOccurrence()) { |
| return methodDeclaration; |
| } |
| } |
| } |
| // return null if the method is no longer in the source code; |
| // this can happen when the context model has not yet |
| // been synchronized with the resource model but is still |
| // asking for an ASTNode (e.g. during a selection event) |
| return null; |
| } |
| |
| public boolean matches(MethodSignature signature, int occurrence) { |
| return this.matches(signature) && (occurrence == this.getOccurrence()); |
| } |
| |
| protected boolean matches(MethodSignature signature) { |
| return signature.getName().equals(this.getName()) |
| && Arrays.equals(this.parameterTypes, signature.getParameterTypes()); |
| } |
| |
| protected boolean matches(MethodDeclaration methodDeclaration) { |
| return this.matches(ASTTools.buildMethodSignature(methodDeclaration)); |
| } |
| |
| // minimize scope of suppressed warnings |
| @SuppressWarnings("unchecked") |
| protected static List<SingleVariableDeclaration> parameters(MethodDeclaration methodDeclaration) { |
| return methodDeclaration.parameters(); |
| } |
| |
| @Override |
| public boolean matches(String memberName, int occurrence) { |
| throw new UnsupportedOperationException("Use #matches(MethodSignature, int)."); //$NON-NLS-1$ |
| } |
| |
| public TextRange getNameTextRange(CompilationUnit astRoot) { |
| MethodDeclaration methodDeclaration = this.getBodyDeclaration(astRoot); |
| // the declaration can be null if the resource is out of sync with the file system |
| return (methodDeclaration == null) ? null : ASTTools.buildTextRange(methodDeclaration.getName()); |
| } |
| |
| /** |
| * return "foo" for a method named "getFoo", "isFoo", "setFoo" |
| */ |
| public String getAttributeName() { |
| return NameTools.convertGetterSetterMethodNameToPropertyName(this.getName()); |
| } |
| |
| public ITypeBinding getTypeBinding(CompilationUnit astRoot) { |
| IMethodBinding methodBinding = getBodyDeclaration(astRoot).resolveBinding(); |
| return (methodBinding == null) ? null : methodBinding.getReturnType(); |
| } |
| |
| public boolean isPersistable(CompilationUnit astRoot) { |
| IMethodBinding binding = this.getBinding(astRoot); |
| return (binding == null) ? false : JPTTools.methodIsPersistablePropertyGetter(new JPTToolsAdapter(binding)); |
| } |
| |
| |
| // ********** internal ********** |
| |
| protected TypeDeclaration getDeclaringTypeDeclaration(CompilationUnit astRoot) { |
| // assume the declaring type is not an enum or annotation |
| // since they do not have field or method declarations |
| return this.getDeclaringType().getBodyDeclaration(astRoot); |
| } |
| |
| protected MethodDeclaration[] getDeclaringTypeMethodDeclarations(CompilationUnit astRoot) { |
| TypeDeclaration typeDeclaration = this.getDeclaringTypeDeclaration(astRoot); |
| // the declaration can be null if the resource is out of sync with the file system |
| return (typeDeclaration == null) ? EMPTY_METHOD_DECLARATION_ARRAY : typeDeclaration.getMethods(); |
| } |
| protected static final MethodDeclaration[] EMPTY_METHOD_DECLARATION_ARRAY = new MethodDeclaration[0]; |
| |
| |
| // ********** JPTTools adapter ********** |
| |
| /** |
| * JPTTools needs an adapter so it can work with either an IMethod |
| * or an IMethodBinding etc. |
| */ |
| protected static class SimpleJPTToolsAdapter |
| implements JPTTools.SimpleMethodAdapter |
| { |
| protected final IMethodBinding methodBinding; |
| |
| protected SimpleJPTToolsAdapter(IMethodBinding methodBinding) { |
| super(); |
| if (methodBinding == null) { |
| throw new NullPointerException(); |
| } |
| this.methodBinding = methodBinding; |
| } |
| |
| public int getModifiers() { |
| return this.methodBinding.getModifiers(); |
| } |
| |
| public String getReturnTypeErasureName() { |
| ITypeBinding returnType = this.methodBinding.getReturnType(); |
| return (returnType == null) ? null : returnType.getTypeDeclaration().getErasure().getQualifiedName(); |
| } |
| |
| public boolean isConstructor() { |
| return this.methodBinding.isConstructor(); |
| } |
| |
| } |
| |
| protected static class JPTToolsAdapter |
| extends SimpleJPTToolsAdapter |
| implements JPTTools.MethodAdapter |
| { |
| protected JPTToolsAdapter(IMethodBinding methodBinding) { |
| super(methodBinding); |
| } |
| |
| public String getName() { |
| return this.methodBinding.getName(); |
| } |
| |
| public int getParametersLength() { |
| return this.methodBinding.getParameterTypes().length; |
| } |
| |
| public JPTTools.SimpleMethodAdapter getSibling(String name) { |
| ITypeBinding typeBinding = this.methodBinding.getDeclaringClass(); |
| if (typeBinding == null) { |
| return null; |
| } |
| for (IMethodBinding sibling : typeBinding.getDeclaredMethods()) { |
| if ((sibling.getParameterTypes().length == 0) |
| && sibling.getName().equals(name)) { |
| return new SimpleJPTToolsAdapter(sibling); |
| } |
| } |
| return null; |
| } |
| |
| public JPTTools.SimpleMethodAdapter getSibling(String name, String parameterTypeErasureName) { |
| ITypeBinding typeBinding = this.methodBinding.getDeclaringClass(); |
| if (typeBinding == null) { |
| return null; |
| } |
| for (IMethodBinding sibling : typeBinding.getDeclaredMethods()) { |
| ITypeBinding[] siblingParmTypes = sibling.getParameterTypes(); |
| if ((siblingParmTypes.length == 1) |
| && sibling.getName().equals(name) |
| && siblingParmTypes[0].getTypeDeclaration().getErasure().getQualifiedName().equals(parameterTypeErasureName)) { |
| return new SimpleJPTToolsAdapter(sibling); |
| } |
| } |
| return null; |
| } |
| |
| } |
| |
| } |