com.google.doclava
Class MemberInfo
java.lang.Object
com.google.doclava.DocInfo
com.google.doclava.MemberInfo
- All Implemented Interfaces:
- Scoped, Comparable
- Direct Known Subclasses:
- FieldInfo, MethodInfo
public abstract class MemberInfo
- extends DocInfo
- implements Comparable, Scoped
Constructor Summary |
MemberInfo(String rawCommentText,
String name,
String signature,
ClassInfo containingClass,
ClassInfo realContainingClass,
boolean isPublic,
boolean isProtected,
boolean isPackagePrivate,
boolean isPrivate,
boolean isFinal,
boolean isStatic,
boolean isSynthetic,
String kind,
SourcePositionInfo position,
AnnotationInstanceInfo[] annotations)
|
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, toString, wait, wait, wait |
MemberInfo
public MemberInfo(String rawCommentText,
String name,
String signature,
ClassInfo containingClass,
ClassInfo realContainingClass,
boolean isPublic,
boolean isProtected,
boolean isPackagePrivate,
boolean isPrivate,
boolean isFinal,
boolean isStatic,
boolean isSynthetic,
String kind,
SourcePositionInfo position,
AnnotationInstanceInfo[] annotations)
isExecutable
public abstract boolean isExecutable()
anchor
public String anchor()
isDefinedLocally
public boolean isDefinedLocally()
- Description copied from class:
DocInfo
- Returns true if the class represented by this object is defined
locally, and thus will be included in local documentation.
- Specified by:
isDefinedLocally
in class DocInfo
relativePath
public String relativePath()
- Description copied from class:
DocInfo
- Returns the relative path that represents this item on a
documentation source.
- Specified by:
relativePath
in class DocInfo
compareTo
public int compareTo(Object that)
- Specified by:
compareTo
in interface Comparable
name
public String name()
signature
public String signature()
realContainingClass
public ClassInfo realContainingClass()
containingClass
public ClassInfo containingClass()
isPublic
public boolean isPublic()
- Specified by:
isPublic
in interface Scoped
isProtected
public boolean isProtected()
- Specified by:
isProtected
in interface Scoped
isPackagePrivate
public boolean isPackagePrivate()
- Specified by:
isPackagePrivate
in interface Scoped
isPrivate
public boolean isPrivate()
- Specified by:
isPrivate
in interface Scoped
scope
public String scope()
isStatic
public boolean isStatic()
isFinal
public boolean isFinal()
isSynthetic
public boolean isSynthetic()
parent
public ContainerInfo parent()
- Specified by:
parent
in class DocInfo
checkLevel
public boolean checkLevel()
kind
public String kind()
annotations
public AnnotationInstanceInfo[] annotations()
Copyright © 2010-2013 Google. All Rights Reserved.