org.mule.devkit.doclet

Class FieldInfo

java.lang.Object

org.mule.devkit.doclet.DocInfo

org.mule.devkit.doclet.MemberInfo

org.mule.devkit.doclet.FieldInfo

All Implemented Interfaces:

Comparable, Scoped

public class FieldInfo
extends MemberInfo

Field Summary

Fields

Modifier and Type	Field and Description
static Comparator<FieldInfo>	comparator

Constructor Summary

Constructors

Constructor and Description
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

Methods

Modifier and Type	Method and Description
FieldInfo	cloneForClass(ClassInfo newContainingClass)
String	constantLiteralValue()
static String	constantLiteralValue(Object val)
Object	constantValue()
String	defaultValue()
TagInfo[]	firstSentenceTags()
TagInfo[]	inlineTags()
boolean	isConfigurable()
boolean	isConsistent(FieldInfo fInfo)
boolean	isConstant()
boolean	isDeprecated()
boolean	isExecutable()
boolean	isOptional()
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 org.mule.devkit.doclet.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 org.mule.devkit.doclet.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 org.mule.devkit.doclet.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)

isOptional

public boolean isOptional()

defaultValue

public String defaultValue()

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)

isConfigurable

public boolean isConfigurable()