com.google.doclava
Class FieldInfo

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

public class FieldInfo
extends MemberInfo


Field Summary
static Comparator<FieldInfo> comparator
           
 
Constructor Summary
FieldInfo(String name, ClassInfo containingClass, ClassInfo realContainingClass, boolean isPublic, boolean isProtected, boolean isPackagePrivate, boolean isPrivate, boolean isFinal, boolean isStatic, boolean isTransient, boolean isVolatile, boolean isSynthetic, TypeInfo type, String rawCommentText, Object constantValue, SourcePositionInfo position, AnnotationInstanceInfo[] annotations)
           
 
Method Summary
 FieldInfo cloneForClass(ClassInfo newContainingClass)
           
 String constantLiteralValue()
           
static String constantLiteralValue(Object val)
           
 Object constantValue()
           
 TagInfo[] firstSentenceTags()
           
 TagInfo[] inlineTags()
           
 boolean isConsistent(FieldInfo fInfo)
           
 boolean isConstant()
           
 boolean isDeprecated()
           
 boolean isExecutable()
           
 boolean isTransient()
           
 boolean isVolatile()
           
static String javaEscapeString(String str)
           
 void makeHDF(com.google.clearsilver.jsilver.data.Data data, String base)
           
 String qualifiedName()
           
 void setDeprecated(boolean deprecated)
           
 TypeInfo type()
           
 
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, signature
 
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
 
Methods inherited from interface com.google.doclava.Scoped
isHidden
 

Field Detail

comparator

public static final Comparator<FieldInfo> comparator
Constructor Detail

FieldInfo

public FieldInfo(String name,
                 ClassInfo containingClass,
                 ClassInfo realContainingClass,
                 boolean isPublic,
                 boolean isProtected,
                 boolean isPackagePrivate,
                 boolean isPrivate,
                 boolean isFinal,
                 boolean isStatic,
                 boolean isTransient,
                 boolean isVolatile,
                 boolean isSynthetic,
                 TypeInfo type,
                 String rawCommentText,
                 Object constantValue,
                 SourcePositionInfo position,
                 AnnotationInstanceInfo[] annotations)
Method Detail

cloneForClass

public FieldInfo cloneForClass(ClassInfo newContainingClass)

qualifiedName

public String qualifiedName()

type

public TypeInfo type()

isConstant

public boolean isConstant()

firstSentenceTags

public TagInfo[] firstSentenceTags()

inlineTags

public TagInfo[] inlineTags()

constantValue

public Object constantValue()

constantLiteralValue

public String constantLiteralValue()

setDeprecated

public void setDeprecated(boolean deprecated)

isDeprecated

public boolean isDeprecated()

constantLiteralValue

public static String constantLiteralValue(Object val)

javaEscapeString

public static String javaEscapeString(String str)

makeHDF

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

isExecutable

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

isTransient

public boolean isTransient()

isVolatile

public boolean isVolatile()

isConsistent

public boolean isConsistent(FieldInfo fInfo)


Copyright © 2010-2013 Google. All Rights Reserved.