com.google.doclava
Class MethodInfo

java.lang.Object
  extended by com.google.doclava.DocInfo
      extended by com.google.doclava.MemberInfo
          extended by com.google.doclava.MethodInfo
All Implemented Interfaces:
AbstractMethodInfo, Scoped, Comparable

public class MethodInfo
extends MemberInfo
implements AbstractMethodInfo


Field Summary
static Comparator<MethodInfo> comparator
           
 
Constructor Summary
MethodInfo(String rawCommentText, TypeInfo[] typeParameters, String name, String signature, ClassInfo containingClass, ClassInfo realContainingClass, boolean isPublic, boolean isProtected, boolean isPackagePrivate, boolean isPrivate, boolean isFinal, boolean isStatic, boolean isSynthetic, boolean isAbstract, boolean isSynchronized, boolean isNative, boolean isAnnotationElement, String kind, String flatSignature, MethodInfo overriddenMethod, TypeInfo returnType, ParameterInfo[] parameters, ClassInfo[] thrownExceptions, SourcePositionInfo position, AnnotationInstanceInfo[] annotations)
           
 
Method Summary
 void addException(String exec)
           
 void addParameter(ParameterInfo p)
           
 MethodInfo cloneForClass(ClassInfo newContainingClass)
           
 AnnotationValueInfo defaultAnnotationElementValue()
           
 TagInfo[] deprecatedTags()
           
 MethodInfo findOverriddenMethod(String name, String signature)
           
 ClassInfo findRealOverriddenClass(String name, String signature)
           
 MethodInfo findRealOverriddenMethod(MethodInfo other, HashSet<ClassInfo> notStrippable)
           
 MethodInfo findSuperclassImplementation(HashSet notStrippable)
           
 InheritedTags firstSentenceTags()
           
 String flatSignature()
           
 String getHashableName()
          Returns a name consistent with the getHashableName().
 String getReason()
           
 TypeInfo[] getTypeParameters()
           
 void init(AnnotationValueInfo defaultAnnotationElementValue)
           
 InheritedTags inlineTags()
           
 boolean isAbstract()
           
 boolean isAnnotationElement()
           
 boolean isConsistent(MethodInfo mInfo)
           
 boolean isDeprecated()
           
 boolean isExecutable()
           
 boolean isNative()
           
 boolean isSynchronized()
           
 boolean isVarArgs()
           
 void makeHDF(com.google.clearsilver.jsilver.data.Data data, String base)
           
 boolean matches(MethodInfo other)
           
 boolean matchesParams(String[] params, String[] dimensions, boolean varargs)
           
 ParameterInfo[] parameters()
           
 ParamTagInfo[] paramTags()
           
 String prettyParameters()
          Returns a printable version of the parameters of this method's signature.
 String prettySignature()
           
 String qualifiedName()
           
 InheritedTags returnTags()
           
 TypeInfo returnType()
           
 SeeTagInfo[] seeTags()
           
 void setDeprecated(boolean deprecated)
           
 void setReason(String reason)
           
 void setVarargs(boolean set)
           
 String signature()
           
 ClassInfo[] thrownExceptions()
           
 boolean throwsException(ClassInfo exception)
           
 ThrowsTagInfo[] throwsTags()
           
 String toString()
           
 String typeArgumentsName(HashSet<String> typeVars)
           
 HashSet<String> typeVariables()
           
 
Methods inherited from class com.google.doclava.MemberInfo
anchor, annotations, checkLevel, compareTo, containingClass, isDefinedLocally, isFinal, isPackagePrivate, isPrivate, isProtected, isPublic, isStatic, isSynthetic, kind, name, parent, realContainingClass, relativePath, scope
 
Methods inherited from class com.google.doclava.DocInfo
addFederatedReference, comment, getFederatedReferences, getRawCommentText, getSince, htmlPage, isDocOnly, isHidden, position, setFederatedReferences, setSince
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.google.doclava.Scoped
isHidden
 

Field Detail

comparator

public static final Comparator<MethodInfo> comparator
Constructor Detail

MethodInfo

public MethodInfo(String rawCommentText,
                  TypeInfo[] typeParameters,
                  String name,
                  String signature,
                  ClassInfo containingClass,
                  ClassInfo realContainingClass,
                  boolean isPublic,
                  boolean isProtected,
                  boolean isPackagePrivate,
                  boolean isPrivate,
                  boolean isFinal,
                  boolean isStatic,
                  boolean isSynthetic,
                  boolean isAbstract,
                  boolean isSynchronized,
                  boolean isNative,
                  boolean isAnnotationElement,
                  String kind,
                  String flatSignature,
                  MethodInfo overriddenMethod,
                  TypeInfo returnType,
                  ParameterInfo[] parameters,
                  ClassInfo[] thrownExceptions,
                  SourcePositionInfo position,
                  AnnotationInstanceInfo[] annotations)
Method Detail

findOverriddenMethod

public MethodInfo findOverriddenMethod(String name,
                                       String signature)

findRealOverriddenMethod

public MethodInfo findRealOverriddenMethod(MethodInfo other,
                                           HashSet<ClassInfo> notStrippable)

findSuperclassImplementation

public MethodInfo findSuperclassImplementation(HashSet notStrippable)

findRealOverriddenClass

public ClassInfo findRealOverriddenClass(String name,
                                         String signature)

isDeprecated

public boolean isDeprecated()

setDeprecated

public void setDeprecated(boolean deprecated)
Specified by:
setDeprecated in interface AbstractMethodInfo

getTypeParameters

public TypeInfo[] getTypeParameters()

cloneForClass

public MethodInfo cloneForClass(ClassInfo newContainingClass)

init

public void init(AnnotationValueInfo defaultAnnotationElementValue)

isAbstract

public boolean isAbstract()

isSynchronized

public boolean isSynchronized()

isNative

public boolean isNative()

flatSignature

public String flatSignature()

inlineTags

public InheritedTags inlineTags()

firstSentenceTags

public InheritedTags firstSentenceTags()

returnTags

public InheritedTags returnTags()

returnType

public TypeInfo returnType()

prettySignature

public String prettySignature()

prettyParameters

public String prettyParameters()
Returns a printable version of the parameters of this method's signature.


getHashableName

public String getHashableName()
Returns a name consistent with the getHashableName().


throwsTags

public ThrowsTagInfo[] throwsTags()

paramTags

public ParamTagInfo[] paramTags()

seeTags

public SeeTagInfo[] seeTags()

deprecatedTags

public TagInfo[] deprecatedTags()

parameters

public ParameterInfo[] parameters()

matchesParams

public boolean matchesParams(String[] params,
                             String[] dimensions,
                             boolean varargs)

makeHDF

public void makeHDF(com.google.clearsilver.jsilver.data.Data data,
                    String base)

typeVariables

public HashSet<String> typeVariables()

isExecutable

public boolean isExecutable()
Specified by:
isExecutable in class MemberInfo

thrownExceptions

public ClassInfo[] thrownExceptions()

typeArgumentsName

public String typeArgumentsName(HashSet<String> typeVars)

isAnnotationElement

public boolean isAnnotationElement()

defaultAnnotationElementValue

public AnnotationValueInfo defaultAnnotationElementValue()

setVarargs

public void setVarargs(boolean set)
Specified by:
setVarargs in interface AbstractMethodInfo

isVarArgs

public boolean isVarArgs()
Specified by:
isVarArgs in interface AbstractMethodInfo

toString

public String toString()
Overrides:
toString in class Object

setReason

public void setReason(String reason)

getReason

public String getReason()

addException

public void addException(String exec)
Specified by:
addException in interface AbstractMethodInfo

addParameter

public void addParameter(ParameterInfo p)
Specified by:
addParameter in interface AbstractMethodInfo

qualifiedName

public String qualifiedName()

signature

public String signature()
Overrides:
signature in class MemberInfo

matches

public boolean matches(MethodInfo other)

throwsException

public boolean throwsException(ClassInfo exception)

isConsistent

public boolean isConsistent(MethodInfo mInfo)


Copyright © 2010-2013 Google. All Rights Reserved.