xjavadoc
public final class XJavaDoc extends Object
UNKNOWN: 3. januar 2002
Nested Class Summary | |
---|---|
class | XJavaDoc.LogMessage |
static class | XJavaDoc.NoInnerClassesPredicate |
Field Summary | |
---|---|
static String | IS_UNICODE
Indicates whether this XJavaDoc was built with or without unicode support |
static int | NO_IMPORTED_PACKAGES
messgage level for reporting unqualified classes when there are no imported
packages |
static int | ONE_OR_MORE_IMPORTED_PACKAGES
messgage level for reporting unqualified classes when there are one or more
imported packages |
static List | PRIMITIVES |
Map | _abstractFileClasses |
Map | _allSourceClasses
This map contains the same classes as _sourceSetSourceClasses, but it is
also populated with additional classes that may be accessed that were not in
the source sets. |
Map | _binaryClasses |
long | _birthday
Remember when we're born. |
String | _docEncoding charset for generated file |
String | _encoding charset for source file |
List | _logMessages
info, error and warning messages related to parsing and class qualification |
Map | _packages |
static HashMap | _primitiveClasses |
Map | _properties |
Set | _sourceSetClassNames |
Set | _sourceSets |
Map | _sourceSetSourceClasses
This map contains all the classes that were passed in the source sets,
excluding all inner classes. |
Collection | _sourceSetSourceClassesWithInnerClasses
This map contains all the classes that were passed in the source sets,
including all inner classes. |
XTagFactory | _tagFactory |
Map | _unknownClasses |
boolean | _useNodeParser
sticky parameter for useNodeParser. |
Constructor Summary | |
---|---|
XJavaDoc() |
Method Summary | |
---|---|
void | addAbstractFile(String qualifiedName, AbstractFile file) |
void | addInnerClassRecursive(XClass outer, Collection c)
Recursively adds inner classes to a collection
|
XPackage | addPackageMaybe(String packageName)
Describe the method
|
void | addPrimitive(String name, String type)
Describe the method
|
void | addSourceClass(SourceClass sourceClass)
Adds a source class to the cache. |
void | addSourceSet(SourceSet sourceSet)
Adds a new set of java sources to be parsed.
|
boolean | classExists(String qualifiedClassName) |
String | dereferenceProperties(String value) |
Class | getClass(String qualifiedName)
Returns the Class with the given name, or null if unknown.
|
String | getDocEncoding()
Getter for generated file charset. |
String | getEncoding()
Getter for source file charset. |
Collection | getOuterSourceClasses()
Returns all classes in the registered source sets
|
static Primitive | getPrimitive(String name)
Gets the Primitive attribute of the XJavaDoc class
|
Map | getPropertyMap() |
Collection | getSourceClasses(Predicate predicate) |
Collection | getSourceClasses()
Returns all classes in the registered source sets, including inner classes
|
AbstractFile | getSourceFile(String qualifiedName)
Gets the SourceFile attribute of the XJavaDoc object
|
static AbstractFile | getSourceFileFor(XProgramElement pe)
Gets the file the pe is contained in. |
XPackage | getSourcePackage(String packageName)
Returns the package. |
Collection | getSourcePackages()
Returns the packages of the specified classes during parsing.
|
XTagFactory | getTagFactory() |
XClass | getXClass(String qualifiedName)
Get the XClass corresponding to the qualifiedName. |
void | logMessage(SourceClass clazz, UnknownClass unknownClass, String unqualifiedClassName, int level) |
static void | parsePropertyString(String value, List fragments, List propertyRefs)
Parses a string containing ${xxx} style property references
into two lists. |
void | printLogMessages(PrintStream out, int level)
Prints the log messages encountered during parsing
|
static void | printMemoryStatus()
Dump to sytem out the status of XJavadoc. |
void | registerTags(String classpath)
Registers tags.
|
static String | replaceProperties(String value, Map keys)
Replaces ${xxx} style constructions in the given value with the
string value of the corresponding data types. |
void | reset(boolean resetTimeStamp)
Resets the caches.
|
SourceClass | scanAndPut(String qualifiedName)
Scan's a class and puts it in the cache.
|
void | setDocEncoding(String docencoding)
Setter for generated file charset. |
void | setEncoding(String encoding)
Setter for source file charset. |
void | setPropertyMap(Map properties) |
void | setUseNodeParser(boolean useNodeParser)
This method can be called prior to parsing so that all classes are parsed
with AST (to make it possible to write the source back to disk)
|
boolean | sourceExists(String qualifiedName)
Checks is the source exists
|
XClass | updateClassTag(String className, String tagName, String parameterName, String parameterValue, int tagIndex)
Describe what the method does
|
XClass | updateMethodTag(String className, String methodNameWithSignature, String tagName, String parameterName, String parameterValue, int tagIndex)
Describe what the method does
|
Parameters: outer The feature to be added to the InnerClassRecursive attribute c The feature to be added to the InnerClassRecursive attribute
Parameters: packageName Describe the method parameter
Returns: Describe the return value
Parameters: name Describe the method parameter type The feature to be added to the Primitive attribute
Parameters: sourceClass Describe the method parameter
Parameters: sourceSet a set of java sources.
Parameters: qualifiedClassName
Returns: true if the class exists, either as source or binary
Parameters: qualifiedName Describe what the parameter does
Returns: The Class value
Returns: encoding
Returns: encoding
Returns: A Collection of XClass
Parameters: name Describe what the parameter does
Returns: The Primitive value
Returns: A Collection of XClass
Parameters: qualifiedName Describe what the parameter does
Returns: The SourceFile value
Parameters: pe the program element we want the source for.
Returns: the file the program element is contained in.
Parameters: packageName
Returns: an XPackage, or null if the packageName is not among the sources.
Returns: Describe the return value
Parameters: qualifiedName Fully qualified class name
Returns: The XClass value
${xxx}
style property references
into two lists. The first list is a collection of text fragments, while the
other is a set of string property names. null
entries in the
first list indicate a property reference from the second list. NOTE: This
method was taken directly from Ant's source code
(org.apache.tools.ant.ProjectHelper) with the BuildException throwing
removed.
Parameters: value Text to parse. Must not be null
. fragments List to add text fragments to. Must not be null
. propertyRefs List to add property names to. Must not be null
.
Parameters: out level
Parameters: classpath where tags are found.
${xxx}
style constructions in the given value with the
string value of the corresponding data types. NOTE: This method was taken
directly from Ant's source code (org.apache.tools.ant.ProjectHelper) and
modified slightly to use a Map instead of a HashMap.
Parameters: value The string to be scanned for property references. May be
null
, in which case this method returns immediately with
no effect. keys Mapping (String to String) of property names to their values.
Must not be null
.
Returns: the original string with the properties replaced, or null
if the original string is null
.
Parameters: resetTimeStamp true if timestamps should be reset too.
Parameters: qualifiedName Describe what the parameter does
Returns: Describe the return value
Parameters: string encoding
Parameters: string encoding
Parameters: useNodeParser
Parameters: qualifiedName the class to check for
Returns: true if source exists.
Parameters: className Describe what the parameter does tagName Describe what the parameter does parameterName Describe what the parameter does parameterValue Describe what the parameter does tagIndex Describe what the parameter does
Returns: Describe the return value
Throws: XJavaDocException Describe the exception
Parameters: className qualified name of class tagName tag name parameterName parameter name parameterValue new parameter value tagIndex index of tag (??) methodNameWithSignature method name followed by signature. no
spaces. Ex:
doIt(java.lang.String,int)
Returns: the class corresponding to the className
Throws: XJavaDocException If the tag for some reason couldn't be updated