duke@1: /* duke@1: * Copyright 1997-2006 Sun Microsystems, Inc. All Rights Reserved. duke@1: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. duke@1: * duke@1: * This code is free software; you can redistribute it and/or modify it duke@1: * under the terms of the GNU General Public License version 2 only, as duke@1: * published by the Free Software Foundation. Sun designates this duke@1: * particular file as subject to the "Classpath" exception as provided duke@1: * by Sun in the LICENSE file that accompanied this code. duke@1: * duke@1: * This code is distributed in the hope that it will be useful, but WITHOUT duke@1: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or duke@1: * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License duke@1: * version 2 for more details (a copy is included in the LICENSE file that duke@1: * accompanied this code). duke@1: * duke@1: * You should have received a copy of the GNU General Public License version duke@1: * 2 along with this work; if not, write to the Free Software Foundation, duke@1: * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. duke@1: * duke@1: * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, duke@1: * CA 95054 USA or visit www.sun.com if you need additional information or duke@1: * have any questions. duke@1: */ duke@1: duke@1: package com.sun.tools.javadoc; duke@1: duke@1: import com.sun.javadoc.*; duke@1: duke@1: import com.sun.tools.javac.util.List; duke@1: import com.sun.tools.javac.util.ListBuffer; duke@1: import com.sun.tools.javac.util.Position; duke@1: import com.sun.tools.javac.code.Flags; duke@1: import com.sun.tools.javac.code.Type; duke@1: import com.sun.tools.javac.code.Symbol; duke@1: import com.sun.tools.javac.code.Symbol.*; duke@1: import com.sun.tools.javac.tree.JCTree.JCMethodDecl; duke@1: duke@1: import java.text.CollationKey; duke@1: duke@1: import java.lang.reflect.Modifier; duke@1: duke@1: /** duke@1: * Represents a method or constructor of a java class. duke@1: * duke@1: * @since 1.2 duke@1: * @author Robert Field duke@1: * @author Neal Gafter (rewrite) duke@1: * @author Scott Seligman (generics, annotations) duke@1: */ duke@1: duke@1: public abstract class ExecutableMemberDocImpl duke@1: extends MemberDocImpl implements ExecutableMemberDoc { duke@1: duke@1: protected final MethodSymbol sym; duke@1: duke@1: /** duke@1: * Constructor. duke@1: */ duke@1: public ExecutableMemberDocImpl(DocEnv env, MethodSymbol sym, duke@1: String rawDocs, JCMethodDecl tree, Position.LineMap lineMap) { duke@1: super(env, sym, rawDocs, tree, lineMap); duke@1: this.sym = sym; duke@1: } duke@1: duke@1: /** duke@1: * Constructor. duke@1: */ duke@1: public ExecutableMemberDocImpl(DocEnv env, MethodSymbol sym) { duke@1: this(env, sym, null, null, null); duke@1: } duke@1: duke@1: /** duke@1: * Returns the flags in terms of javac's flags duke@1: */ duke@1: protected long getFlags() { duke@1: return sym.flags(); duke@1: } duke@1: duke@1: /** duke@1: * Identify the containing class duke@1: */ duke@1: protected ClassSymbol getContainingClass() { duke@1: return sym.enclClass(); duke@1: } duke@1: duke@1: /** duke@1: * Return true if this method is native duke@1: */ duke@1: public boolean isNative() { duke@1: return Modifier.isNative(getModifiers()); duke@1: } duke@1: duke@1: /** duke@1: * Return true if this method is synchronized duke@1: */ duke@1: public boolean isSynchronized() { duke@1: return Modifier.isSynchronized(getModifiers()); duke@1: } duke@1: duke@1: /** duke@1: * Return true if this method was declared to take a variable number duke@1: * of arguments. duke@1: */ duke@1: public boolean isVarArgs() { duke@1: return ((sym.flags() & Flags.VARARGS) != 0 duke@1: && !env.legacyDoclet); duke@1: } duke@1: duke@1: /** duke@1: * Returns true if this field was synthesized by the compiler. duke@1: */ duke@1: public boolean isSynthetic() { duke@1: return ((sym.flags() & Flags.SYNTHETIC) != 0); duke@1: } duke@1: duke@1: public boolean isIncluded() { duke@1: return containingClass().isIncluded() && env.shouldDocument(sym); duke@1: } duke@1: duke@1: /** duke@1: * Return the throws tags in this method. duke@1: * duke@1: * @return an array of ThrowTagImpl containing all {@code @exception} duke@1: * and {@code @throws} tags. duke@1: */ duke@1: public ThrowsTag[] throwsTags() { duke@1: return comment().throwsTags(); duke@1: } duke@1: duke@1: /** duke@1: * Return the param tags in this method, excluding the type duke@1: * parameter tags. duke@1: * duke@1: * @return an array of ParamTagImpl containing all {@code @param} tags. duke@1: */ duke@1: public ParamTag[] paramTags() { duke@1: return comment().paramTags(); duke@1: } duke@1: duke@1: /** duke@1: * Return the type parameter tags in this method. duke@1: */ duke@1: public ParamTag[] typeParamTags() { duke@1: return env.legacyDoclet duke@1: ? new ParamTag[0] duke@1: : comment().typeParamTags(); duke@1: } duke@1: duke@1: /** duke@1: * Return exceptions this method or constructor throws. duke@1: * duke@1: * @return an array of ClassDoc[] representing the exceptions duke@1: * thrown by this method. duke@1: */ duke@1: public ClassDoc[] thrownExceptions() { duke@1: ListBuffer l = new ListBuffer(); duke@1: for (Type ex : sym.type.getThrownTypes()) { duke@1: ex = env.types.erasure(ex); duke@1: //### Will these casts succeed in the face of static semantic duke@1: //### errors in the documented code? duke@1: ClassDocImpl cdi = env.getClassDoc((ClassSymbol)ex.tsym); duke@1: if (cdi != null) l.append(cdi); duke@1: } duke@1: return l.toArray(new ClassDocImpl[l.length()]); duke@1: } duke@1: duke@1: /** duke@1: * Return exceptions this method or constructor throws. duke@1: * Each array element is either a ClassDoc or a duke@1: * TypeVariable. duke@1: */ duke@1: public com.sun.javadoc.Type[] thrownExceptionTypes() { duke@1: return TypeMaker.getTypes(env, sym.type.getThrownTypes()); duke@1: } duke@1: duke@1: /** duke@1: * Get argument information. duke@1: * duke@1: * @see ParameterImpl duke@1: * duke@1: * @return an array of ParameterImpl, one element per argument duke@1: * in the order the arguments are present. duke@1: */ duke@1: public Parameter[] parameters() { duke@1: // generate the parameters on the fly: they're not cached duke@1: List params = sym.params(); duke@1: Parameter result[] = new Parameter[params.length()]; duke@1: duke@1: int i = 0; duke@1: for (VarSymbol param : params) { duke@1: result[i++] = new ParameterImpl(env, param); duke@1: } duke@1: return result; duke@1: } duke@1: duke@1: /** duke@1: * Return the formal type parameters of this method or constructor. duke@1: * Return an empty array if there are none. duke@1: */ duke@1: public TypeVariable[] typeParameters() { duke@1: if (env.legacyDoclet) { duke@1: return new TypeVariable[0]; duke@1: } duke@1: TypeVariable res[] = new TypeVariable[sym.type.getTypeArguments().length()]; duke@1: TypeMaker.getTypes(env, sym.type.getTypeArguments(), res); duke@1: return res; duke@1: } duke@1: duke@1: /** duke@1: * Get the signature. It is the parameter list, type is qualified. duke@1: * For instance, for a method mymethod(String x, int y), duke@1: * it will return (java.lang.String,int). duke@1: */ duke@1: public String signature() { duke@1: return makeSignature(true); duke@1: } duke@1: duke@1: /** duke@1: * Get flat signature. All types are not qualified. duke@1: * Return a String, which is the flat signiture of this member. duke@1: * It is the parameter list, type is not qualified. duke@1: * For instance, for a method mymethod(String x, int y), duke@1: * it will return (String, int). duke@1: */ duke@1: public String flatSignature() { duke@1: return makeSignature(false); duke@1: } duke@1: duke@1: private String makeSignature(boolean full) { duke@1: StringBuffer result = new StringBuffer(); duke@1: result.append("("); duke@1: for (List types = sym.type.getParameterTypes(); types.nonEmpty(); ) { jjg@74: Type t = types.head; duke@1: result.append(TypeMaker.getTypeString(env, t, full)); duke@1: types = types.tail; duke@1: if (types.nonEmpty()) { duke@1: result.append(", "); duke@1: } duke@1: } duke@1: if (isVarArgs()) { duke@1: int len = result.length(); duke@1: result.replace(len - 2, len, "..."); duke@1: } duke@1: result.append(")"); duke@1: return result.toString(); duke@1: } duke@1: duke@1: protected String typeParametersString() { duke@1: return TypeMaker.typeParametersString(env, sym, true); duke@1: } duke@1: duke@1: /** duke@1: * Generate a key for sorting. duke@1: */ duke@1: CollationKey generateKey() { duke@1: String k = name() + flatSignature() + typeParametersString(); duke@1: // ',' and '&' are between '$' and 'a': normalize to spaces. duke@1: k = k.replace(',', ' ').replace('&', ' '); duke@1: // System.out.println("COLLATION KEY FOR " + this + " is \"" + k + "\""); duke@1: return env.doclocale.collator.getCollationKey(k); duke@1: } duke@1: duke@1: /** duke@1: * Return the source position of the entity, or null if duke@1: * no position is available. duke@1: */ duke@1: public SourcePosition position() { duke@1: if (sym.enclClass().sourcefile == null) return null; duke@1: return SourcePositionImpl.make(sym.enclClass().sourcefile.toString(), duke@1: (tree==null) ? 0 : tree.pos, duke@1: lineMap); duke@1: } duke@1: }