com.google.doclava
Class MethodInfo
java.lang.Object
com.google.doclava.DocInfo
com.google.doclava.MemberInfo
com.google.doclava.MethodInfo
- All Implemented Interfaces:
- AbstractMethodInfo, Scoped, Comparable
public class MethodInfo
- extends MemberInfo
- implements AbstractMethodInfo
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)
|
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 |
comparator
public static final Comparator<MethodInfo> comparator
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)
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.