xjavadoc
public final class SourceClass extends AbstractClass
UNKNOWN: 3. januar 2002
Field Summary | |
---|---|
static int | instanceCount |
SimpleNode | _compilationUnit
The root node of the AST |
boolean | _dirty
doe we nees saving? |
Reader | _in |
boolean | _isExtraClass |
Map | _qualifiedClasses |
AbstractFile | _sourceFile
Keep a ref to the file in case of warning reporting |
List | _tagsForValidation |
Constructor Summary | |
---|---|
SourceClass(SourceClass containingClass, XTagFactory tagFactory)
Constructor to use for inner classes.
| |
SourceClass(SourceClass mainClass, int dummy, XTagFactory tagFactory)
Constructor to use for "extra" classes, that is, secondary classes that
figure in the same source.
| |
SourceClass(XJavaDoc xJavaDoc, File sourceFile, XTagFactory tagFactory)
Constructor to use for outer classes
| |
SourceClass(XJavaDoc xJavaDoc, Reader sourceFile, XTagFactory tagFactory)
Constructor to use for outer classes
| |
SourceClass(XJavaDoc xJavaDoc, File sourceFile, boolean useNodeParser, XTagFactory tagFactory) | |
SourceClass(XJavaDoc xJavaDoc, AbstractFile sourceFile, boolean useNodeParser, XTagFactory tagFactory, String encoding)
Constructor to use for outer classes
|
Method Summary | |
---|---|
void | addTagForValidation(DefaultXTag tag) |
SimpleNode | getCompilationUnit() |
AbstractFile | getFile() |
static String | getFileName(String qualifiedName)
Describe what the method does
|
String | getNextAnonymousClassName()
Returns "1", "2", etc., depending on how many inner classes we have.
|
Reader | getReader()
Returns a reader for the source code.
|
boolean | isExtraClass() |
boolean | isOuterClass()
Gets the OuterClass attribute of the SourceClass object
|
boolean | isPrimitive() |
boolean | isWriteable()
Gets the Writeable attribute of the SourceClass object
|
long | lastModified()
Describe what the method does
|
void | parse(boolean useNodeParser)
Describe what the method does
|
void | print(Writer out)
Prints this class to a stream
|
XClass | qualify(String unqualifiedClassName)
Returns fully qualified name of a class. |
void | reset() |
String | save(File rootDir)
Saves the class at root dir rootDir. |
boolean | saveNeeded() |
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 ) |
String | unqualifiedNameInImportedClasses(String unqualifiedClassName) |
XClass | unqualifiedNameInImportedClassesInnerClasses(String unqualifiedClassName) |
String | unqualifiedNameInImportedPackages(String unqualifiedClassName)
Describe what the method does
|
String | unqualifiedNameInInnerClasses(String unqualifiedClassName)
Describe what the method does
|
String | unqualifiedNameInInnerClassesOfSuperClass(String unqualifiedClassName)
Resolves Inner classes that exist in the super class hierarchy.
|
String | unqualifiedNameInInnerInterface(String unqualifiedClassName)
Resolves Inner interfaces that exist in current class.
|
String | unqualifiedNameInJavaDotLang(String unqualifiedClassName)
Returns the fully qualified class name if it's found in java.lang, otherwise
null.
|
String | unqualifiedNameInTheSameClassAsAnInnerClass(String unqualifiedClassName) |
String | unqualifiedNameInTheSamePackage(String unqualifiedClassName)
Describe what the method does
|
void | validateTags()
Called by XJavaDoc after the entire source is parsed, but only if validation
is on.
|
Parameters: containingClass The containing class;
Parameters: mainClass The containing class. Or rather the "main" class in the source. dummy
Parameters: sourceFile The file containing the source
Parameters: sourceFile The file containing the source
Parameters: sourceFile useNodeParser
Parameters: sourceFile The file containing the source useNodeParser
Parameters: qualifiedName Describe what the parameter does
Returns: Describe the return value
Returns: String containing number of next anonymous inner class
Returns: a reader for the source code.
Returns: The OuterClass value
Returns: The Writeable value
Returns: Describe the return value
Parameters: useNodeParser Describe what the parameter does
Parameters: out Describe what the parameter does
Parameters: unqualifiedClassName Describe what the parameter does
Returns: Describe the return value
Parameters: rootDir the root directory.
Returns: the relative fileName to which the file was saved.
Throws: IOException if the file couldn't be saved
Parameters: compilationUnit The new CompilationUnit value
Parameters: unqualifiedClassName Describe what the parameter does
Returns: Describe the return value
Parameters: unqualifiedClassName Describe what the parameter does
Returns: Describe the return value
Parameters: unqualifiedClassName Name of the class to resolve
Returns: The qualified name of the inner class.
Parameters: unqualifiedClassName Name of the class to resolve
Returns: The qualified name of the inner class.
Parameters: unqualifiedClassName
Returns: fully qualified class name, or null
Parameters: unqualifiedClassName Describe what the parameter does
Returns: Describe the return value
Throws: TagValidationException