Eclipse中setter/getter方法自动添加属性注释

/* */ package org.eclipse.jdt.internal.corext.codemanipulation; /* */ /* */ import org.eclipse.core.runtime.CoreException; /* */ import org.eclipse.jdt.core.Flags; /* */ import org.eclipse.jdt.core.IField; /* */ import org.eclipse.jdt.core.IJavaProject; /* */ import org.eclipse.jdt.core.IMethod; import org.eclipse.jdt.core.ISourceRange; /* */ import org.eclipse.jdt.core.IType; /* */ import org.eclipse.jdt.core.JavaModelException; /* */ import org.eclipse.jdt.core.NamingConventions; /* */ import org.eclipse.jdt.core.Signature; /* */ import org.eclipse.jdt.core.dom.AST; /* */ import org.eclipse.jdt.core.dom.ASTNode; /* */ import org.eclipse.jdt.core.dom.Assignment; /* */ import org.eclipse.jdt.core.dom.Assignment.Operator; /* */ import org.eclipse.jdt.core.dom.CastExpression; /* */ import org.eclipse.jdt.core.dom.Expression; /* */ import org.eclipse.jdt.core.dom.ITypeBinding; /* */ import org.eclipse.jdt.core.dom.IVariableBinding; /* */ import org.eclipse.jdt.core.dom.InfixExpression; /* */ import org.eclipse.jdt.core.dom.NumberLiteral; /* */ import org.eclipse.jdt.core.dom.ParenthesizedExpression; /* */ import org.eclipse.jdt.core.dom.PostfixExpression; /* */ import org.eclipse.jdt.core.dom.PrefixExpression; /* */ import org.eclipse.jdt.core.dom.PrimitiveType; /* */ import org.eclipse.jdt.core.dom.rewrite.ASTRewrite; /* */ import org.eclipse.jdt.internal.corext.dom.ASTNodes; /* */ import org.eclipse.jdt.internal.corext.dom.NecessaryParenthesesChecker; /* */ import org.eclipse.jdt.internal.corext.util.JavaModelUtil; /* */ import org.eclipse.jdt.internal.corext.util.JdtFlags; /* */ import org.eclipse.jdt.ui.CodeGeneration; /* */ /* */ public class GetterSetterUtil /* */ { /* 48 */ private static final String[] EMPTY = new String[0]; /* */ /* */ public static String getGetterName(IField field, String[] excludedNames) /* */ throws JavaModelException /* */ { /* 55 */ boolean useIs = StubUtility.useIsForBooleanGetters(field.getJavaProject()); /* 56 */ return getGetterName(field, excludedNames, useIs); /* */ } /* */ /* */ private static String getGetterName(IField field, String[] excludedNames, boolean useIsForBoolGetters) throws JavaModelException { /* 60 */ if (excludedNames == null) { /* 61 */ excludedNames = EMPTY; /* */ } /* 63 */ return getGetterName(field.getJavaProject(), field.getElementName(), field.getFlags(), (useIsForBoolGetters) && (JavaModelUtil.isBoolean(field)), excludedNames); /* */ } /* */ /* */ public static String getGetterName(IVariableBinding variableType, IJavaProject project, String[] excludedNames, boolean isBoolean) { /* 67 */ boolean useIs = (StubUtility.useIsForBooleanGetters(project)) && (isBoolean); /* 68 */ return getGetterName(project, variableType.getName(), variableType.getModifiers(), useIs, excludedNames); /* */ } /* */ /* */ public static String getGetterName(IJavaProject project, String fieldName, int flags, boolean isBoolean, String[] excludedNames) { /* 72 */ return NamingConventions.suggestGetterName(project, fieldName, flags, isBoolean, excludedNames); /* */ } /* */ /* */ public static String getSetterName(IVariableBinding variableType, IJavaProject project, String[] excludedNames, boolean isBoolean) { /* 76 */ return getSetterName(project, variableType.getName(), variableType.getModifiers(), isBoolean, excludedNames); /* */ } /* */ /* */ public static String getSetterName(IJavaProject project, String fieldName, int flags, boolean isBoolean, String[] excludedNames) { /* 80 */ boolean useIs = StubUtility.useIsForBooleanGetters(project); /* 81 */ return NamingConventions.suggestSetterName(project, fieldName, flags, (useIs) && (isBoolean), excludedNames); /* */ } /* */ /* */ public static String getSetterName(IField field, String[] excludedNames) throws JavaModelException { /* 85 */ if (excludedNames == null) { /* 86 */ excludedNames = EMPTY; /* */ } /* 88 */ return getSetterName(field.getJavaProject(), field.getElementName(), field.getFlags(), JavaModelUtil.isBoolean(field), excludedNames); /* */ } /* */ /* */ public static IMethod getGetter(IField field) throws JavaModelException { /* 92 */ String getterName = getGetterName(field, EMPTY, true); /* 93 */ IMethod primaryCandidate = JavaModelUtil.findMethod(getterName, new String[0], false, field.getDeclaringType()); /* 94 */ if ((!JavaModelUtil.isBoolean(field)) || ((primaryCandidate != null) && (primaryCandidate.exists()))) { /* 95 */ return primaryCandidate; /* */ } /* 97 */ String secondCandidateName = getGetterName(field, EMPTY, false); /* 98 */ return JavaModelUtil.findMethod(secondCandidateName, new String[0], false, field.getDeclaringType()); /* */ } /* */ /* */ public static IMethod getSetter(IField field) throws JavaModelException { /* 102 */ String[] args = { field.getTypeSignature() }; /* 103 */ return JavaModelUtil.findMethod(getSetterName(field, EMPTY), args, false, field.getDeclaringType()); /* */ } /* */ /* */ public static String getSetterStub(IField field, String setterName, boolean addComments, int flags) /* */ throws CoreException /* */ { /* 118 */ String fieldName = field.getElementName(); /* 119 */ IType parentType = field.getDeclaringType(); /* */ /* 121 */ String returnSig = field.getTypeSignature(); /* 122 */ String typeName = Signature.toString(returnSig); /* */ /* 124 */ IJavaProject project = field.getJavaProject(); /* */ /* 126 */ String accessorName = StubUtility.getBaseName(field); /* 127 */ String argname = StubUtility.suggestArgumentName(project, accessorName, EMPTY); /* */ /* 129 */ boolean isStatic = Flags.isStatic(flags); /* 130 */ boolean isSync = Flags.isSynchronized(flags); /* 131 */ boolean isFinal = Flags.isFinal(flags); /* */ /* 133 */ String lineDelim = "\n"; /* 134 */ StringBuffer buf = new StringBuffer(); /* 135 */ if (addComments) { /* 136 */ String comment = CodeGeneration.getSetterComment(field.getCompilationUnit(), parentType.getTypeQualifiedName('.'), setterName, field.getElementName(), typeName, argname, accessorName, lineDelim); ISourceRange sr= field.getJavadocRange(); if (null != sr) { String filedComment= field.getSource(); filedComment= filedComment.substring(0, sr.getLength()).replaceAll("[\n,\r,*,/,\t]", "").trim(); //$NON-NLS-1$ //$NON-NLS-2$ comment= comment.replace("#{bare_field_comment}", filedComment); //$NON-NLS-1$ } /* 137 */ if (comment != null) { /* 138 */ buf.append(comment); /* 139 */ buf.append(lineDelim); /* */ } /* */ } /* 142 */ buf.append(JdtFlags.getVisibilityString(flags)); /* 143 */ buf.append(' '); /* 144 */ if (isStatic) /* 145 */ buf.append("static "); /* 146 */ if (isSync) /* 147 */ buf.append("synchronized "); /* 148 */ if (isFinal) { /* 149 */ buf.append("final "); /* */ } /* 151 */ buf.append("void "); /* 152 */ buf.append(setterName); /* 153 */ buf.append('('); /* 154 */ buf.append(typeName); /* 155 */ buf.append(' '); /* 156 */ buf.append(argname); /* 157 */ buf.append(") {"); /* 158 */ buf.append(lineDelim); /* */ /* 160 */ boolean useThis = StubUtility.useThisForFieldAccess(project); /* 161 */ if ((argname.equals(fieldName)) || ((useThis) && (!isStatic))) { /* 162 */ if (isStatic) /* 163 */ fieldName = parentType.getElementName()