|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectxjavadoc.AbstractProgramElement
xjavadoc.AbstractClass
xjavadoc.SourceClass
public final class SourceClass
This class represents a class for which the source code is available XJavaDocFil
Field Summary | |
---|---|
private SimpleNode |
_compilationUnit
The root node of the AST |
private boolean |
_dirty
doe we nees saving? |
private java.io.Reader |
_in
|
private boolean |
_isExtraClass
|
private java.util.Map |
_qualifiedClasses
|
private AbstractFile |
_sourceFile
Keep a ref to the file in case of warning reporting |
private java.util.List |
_tagsForValidation
|
static int |
instanceCount
|
Fields inherited from class xjavadoc.AbstractProgramElement |
---|
EMPTY_LIST |
Constructor Summary | |
---|---|
SourceClass(SourceClass mainClass,
int dummy,
XTagFactory tagFactory)
Constructor to use for "extra" classes, that is, secondary classes that figure in the same source. |
|
SourceClass(SourceClass containingClass,
XTagFactory tagFactory)
Constructor to use for inner classes. |
|
SourceClass(XJavaDoc xJavaDoc,
AbstractFile sourceFile,
boolean useNodeParser,
XTagFactory tagFactory,
java.lang.String encoding)
Constructor to use for outer classes |
|
SourceClass(XJavaDoc xJavaDoc,
java.io.File sourceFile,
boolean useNodeParser,
XTagFactory tagFactory)
|
|
SourceClass(XJavaDoc xJavaDoc,
java.io.File sourceFile,
XTagFactory tagFactory)
Constructor to use for outer classes |
|
SourceClass(XJavaDoc xJavaDoc,
java.io.Reader sourceFile,
XTagFactory tagFactory)
Constructor to use for outer classes |
Method Summary | |
---|---|
void |
addTagForValidation(DefaultXTag tag)
|
SimpleNode |
getCompilationUnit()
|
AbstractFile |
getFile()
|
static java.lang.String |
getFileName(java.lang.String qualifiedName)
Describe what the method does |
java.lang.String |
getNextAnonymousClassName()
Returns "1", "2", etc., depending on how many inner classes we have. |
java.io.Reader |
getReader()
Returns a reader for the source code. |
boolean |
isExtraClass()
|
private boolean |
isOuterClass()
Gets the OuterClass attribute of the SourceClass object |
boolean |
isPrimitive()
Returns true if this class is a primitive. |
boolean |
isWriteable()
Gets the Writeable attribute of the SourceClass object |
long |
lastModified()
Describe what the method does |
private void |
parse(boolean useNodeParser)
Describe what the method does |
void |
print(java.io.Writer out)
Prints this class to a stream |
XClass |
qualify(java.lang.String unqualifiedClassName)
Returns fully qualified name of a class. |
void |
reset()
|
java.lang.String |
save(java.io.File rootDir)
Saves the class at root dir rootDir. |
boolean |
saveNeeded()
whether class needs saving |
void |
setCompilationUnit(SimpleNode compilationUnit)
Called by JavaParser at the end of the parsing |
void |
setDirty()
say this class is dirty and needs saving propagate to outer class ( if any ) |
private java.lang.String |
unqualifiedNameInImportedClasses(java.lang.String unqualifiedClassName)
|
private XClass |
unqualifiedNameInImportedClassesInnerClasses(java.lang.String unqualifiedClassName)
|
private java.lang.String |
unqualifiedNameInImportedPackages(java.lang.String unqualifiedClassName)
Describe what the method does |
private java.lang.String |
unqualifiedNameInInnerClasses(java.lang.String unqualifiedClassName)
Describe what the method does |
private java.lang.String |
unqualifiedNameInInnerClassesOfSuperClass(java.lang.String unqualifiedClassName)
Resolves Inner classes that exist in the super class hierarchy. |
private java.lang.String |
unqualifiedNameInInnerInterface(java.lang.String unqualifiedClassName)
Resolves Inner interfaces that exist in current class. |
private java.lang.String |
unqualifiedNameInJavaDotLang(java.lang.String unqualifiedClassName)
Returns the fully qualified class name if it's found in java.lang, otherwise null. |
private java.lang.String |
unqualifiedNameInTheSameClassAsAnInnerClass(java.lang.String unqualifiedClassName)
|
private java.lang.String |
unqualifiedNameInTheSamePackage(java.lang.String unqualifiedClassName)
Describe what the method does |
void |
validateTags()
Called by XJavaDoc after the entire source is parsed, but only if validation is on. |
Methods inherited from class xjavadoc.AbstractProgramElement |
---|
addModifier, getContainingAbstractClass, getContainingClass, getDoc, getModifiers, getModifierSpecifier, getTagFactory, getXJavaDoc, isAbstract, isFinal, isPackagePrivate, isPrivate, isProtected, isPublic, isStatic, setToken |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Methods inherited from interface xjavadoc.XClass |
---|
getContainingClass, isAbstract |
Methods inherited from interface xjavadoc.XProgramElement |
---|
getDoc, getModifiers, getModifierSpecifier, getXJavaDoc, isFinal, isPackagePrivate, isPrivate, isProtected, isPublic, isStatic |
Field Detail |
---|
public static int instanceCount
private final java.util.Map _qualifiedClasses
private final boolean _isExtraClass
private final java.util.List _tagsForValidation
private SimpleNode _compilationUnit
private java.io.Reader _in
private AbstractFile _sourceFile
private boolean _dirty
Constructor Detail |
---|
public SourceClass(SourceClass containingClass, XTagFactory tagFactory)
containingClass
- The containing class;public SourceClass(SourceClass mainClass, int dummy, XTagFactory tagFactory)
mainClass
- The containing class. Or rather the "main" class in the
source.dummy
- public SourceClass(XJavaDoc xJavaDoc, java.io.File sourceFile, XTagFactory tagFactory)
sourceFile
- The file containing the sourcepublic SourceClass(XJavaDoc xJavaDoc, java.io.Reader sourceFile, XTagFactory tagFactory)
sourceFile
- The file containing the sourcepublic SourceClass(XJavaDoc xJavaDoc, java.io.File sourceFile, boolean useNodeParser, XTagFactory tagFactory)
sourceFile
- useNodeParser
- public SourceClass(XJavaDoc xJavaDoc, AbstractFile sourceFile, boolean useNodeParser, XTagFactory tagFactory, java.lang.String encoding)
sourceFile
- The file containing the sourceuseNodeParser
- Method Detail |
---|
public static java.lang.String getFileName(java.lang.String qualifiedName)
qualifiedName
- Describe what the parameter does
public boolean isExtraClass()
public java.lang.String getNextAnonymousClassName()
private boolean isOuterClass()
public boolean isWriteable()
public SimpleNode getCompilationUnit()
public java.io.Reader getReader()
public AbstractFile getFile()
public boolean isPrimitive()
XClass
public void setDirty()
public void setCompilationUnit(SimpleNode compilationUnit)
compilationUnit
- The new CompilationUnit valuepublic void validateTags() throws TagValidationException
TagValidationException
public void addTagForValidation(DefaultXTag tag)
public boolean saveNeeded()
XClass
public long lastModified()
lastModified
in interface XClass
lastModified
in class AbstractClass
public void print(java.io.Writer out)
out
- Describe what the parameter doespublic java.lang.String save(java.io.File rootDir) throws java.io.IOException
save
in interface XClass
save
in class AbstractClass
rootDir
- the root directory.
java.io.IOException
- if the file couldn't be savedpublic XClass qualify(java.lang.String unqualifiedClassName)
qualify
in interface XClass
qualify
in class AbstractClass
unqualifiedClassName
- Describe what the parameter does
public void reset()
reset
in class AbstractClass
private final java.lang.String unqualifiedNameInImportedClasses(java.lang.String unqualifiedClassName)
private final XClass unqualifiedNameInImportedClassesInnerClasses(java.lang.String unqualifiedClassName)
private final java.lang.String unqualifiedNameInInnerClasses(java.lang.String unqualifiedClassName)
unqualifiedClassName
- Describe what the parameter does
private final java.lang.String unqualifiedNameInInnerInterface(java.lang.String unqualifiedClassName)
unqualifiedClassName
- Name of the class to resolve
private final java.lang.String unqualifiedNameInInnerClassesOfSuperClass(java.lang.String unqualifiedClassName)
unqualifiedClassName
- Name of the class to resolve
private final java.lang.String unqualifiedNameInImportedPackages(java.lang.String unqualifiedClassName)
unqualifiedClassName
- Describe what the parameter does
private final java.lang.String unqualifiedNameInJavaDotLang(java.lang.String unqualifiedClassName)
unqualifiedClassName
-
private final java.lang.String unqualifiedNameInTheSamePackage(java.lang.String unqualifiedClassName)
unqualifiedClassName
- Describe what the parameter does
private final java.lang.String unqualifiedNameInTheSameClassAsAnInnerClass(java.lang.String unqualifiedClassName)
private void parse(boolean useNodeParser)
useNodeParser
- Describe what the parameter does
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |